Skip to main content
GET
/
users
cURL
curl --request GET \
  --url https://api.example.com/users
{
  "data": [
    {
      "id": 1,
      "first_name": "John",
      "last_name": "Doe",
      "name": "John Doe",
      "title": "Manager",
      "active": true,
      "avatar": {},
      "archived_at": 123,
      "participant_type": "<string>",
      "subtext": "Manager - HQ (Sales)",
      "department": {
        "id": 10,
        "name": "Sales"
      },
      "unit": {
        "id": 5,
        "name": "HQ"
      }
    }
  ]
}

Query Parameters

basic
boolean

Return basic user information instead of full user information

limit
integer

Limit the number of users returned

page
integer

Page number

Search query

sort
string

Sort by

order
string

Order direction

filter
string

Filter by

Response

200 - application/json

A list of users.

data
object[]