Skip to main content
GET
/
v1
/
core
/
users
Get users
curl --request GET \
  --url https://api.example.com/v1/core/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "organizationId": "<string>",
      "phoneNumber": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "memberTeamId": "<string>",
      "coachTeamIds": [
        "<string>"
      ],
      "externalId": "<string>",
      "createdAt": "<string>",
      "disabled": true,
      "billable": true,
      "contactSettings": {
        "suppressEmails": true,
        "suppressEmailErrors": false
      }
    }
  ],
  "cursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

disabled
boolean | null

Optionally filter by users which you have disabled.

excludeSiroUsers
boolean | null

Whether to exclude users with Siro emails (including bot users)

externalId
string

Optionally filter to Siro user linked to external system with this external Id

Response

200 - application/json

Get users

data
object[]
required
cursor
string | null
required

Opaque cursor for pagination