v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Users

List Users

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page.

Allowed For

  • Admins, Agents and Light Agents
get/api/v2/users

Query parameters

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

role'end-user' | 'agent' | 'admin'

Filters the results by role. Possible values are "end-user", "agent", or "admin"

role[]string

Filters the results by more than one role using the format role[]={role}&role[]={role}

permission_setinteger

For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request

external_idstring

List users by external id. External id has to be unique for each user under the same account.

Response

Success response