Skip to main content
GET
List admins

Authorizations

Authorization
string
header
required

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

Query Parameters

page[cursor]
string

Cursor token from the previous response page.

page[limit]
integer

Number of admins to return.

Required range: 1 <= x <= 100
sort
enum<string>

Sort order. Prefix with - to reverse.

Available options:
created_at,
-created_at,
name,
-name,
username,
-username,
email,
-email
filter[active]
boolean

Restrict to active (true) or inactive (false) admins.

Free-text match across name, email, username, and external id.

filter[created_at_from]
string<date-time>

Only admins created at or after this time.

filter[created_at_to]
string<date-time>

Only admins created at or before this time.

Response

Success

admins
object[]
required
meta
object
required
status
integer