Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
userManagement

Get a list of users.

Get a list of all users in the organization. The response is paginated with a default limit of 100 users per page.

get/v1/users

Query parameters

limitinteger

Limit the number of users returned in the response. The number of users returned may be less than the limit.

tokenstring

Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

sortBystring

Sort the list of users by the firstName, lastName, or email field.

emailstring

Find user with the given email address.

includeServiceAccountsboolean

Include service accounts while listing users within the organization.

Response

A paginated list of users in the organization.

nextstring

Next continuation token.

Example response

{
  "data": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "email": "johndoe@acme.com",
      "roleIds": [
        "00000000000001DF",
        "00000000000002D2"
      ],
      "createdAt": "2018-10-16T09:10:00Z",
      "createdBy": "0000000006743FDD",
      "modifiedAt": "2018-10-16T09:10:00Z",
      "modifiedBy": "0000000006743FE8",
      "id": "000000000FE20FE2",
      "isActive": true
    }
  ],
  "next": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc"
}