HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Admins / Listing

Get a list of administrators.

Returns administrators belonging to the same operator as the API token.
Results are paginated using cursor-based pagination.

Use filter[status], filter[adminType], filter[roleId] and filter[email] to narrow the listing. They combine with each other and with filter[operatorId] using AND. filter[email] is a case-insensitive exact match that returns every matching administrator; a filter that matches no administrator returns an empty list.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
object

Filters combine with each other using AND. A blank filter value is ignored.
status and adminType use the same values as the matching response properties; an unknown value is refused with 422.

integer
1 to 100
Defaults to 100

The number of items to return per page.

string

The cursor to fetch the next page.

Do not construct this value manually. Use one of the following methods:

  • Use the value from the previous response's links.next to fetch the next page
  • Pass an empty string (e.g., ?cursor or ?cursor=) to initiate cursor pagination on the first page
include
array of strings
include
Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json