List all administrators

Warning: This API version will be deprecated on March 26, 2025, to provide you with the latest features, including detailed information about the timezone and status for each admin.
Upgrade to v2 API now to experience enhanced functionality and performance.

Log in to see full request history
Query Params
int64
Defaults to 1

Specify the number of the result's page you wish to receive.

int64
≤ 500
Defaults to 25

Specify the number of results that can fit on one page of results.

string

Specify the part of admin's name or email by which you intend to search and list admins. Example, 'Smith' will return admin with the name of 'John Smith'.

string
Defaults to id

Specify the parameter by which you intend to sort the admin list results. The available sorting options are:

  • id: Sort by the admin's unique identifier.
  • name: Sort by the admin's first name.
  • email: Sort by the admin's email address.

By default, the id is used to sort the results.

string
Defaults to ASC

Specify the order in which you intend to sort admins list results.

filters
array of strings

Specify the filters you wish to use for filtering admins list.

filters
adminIDs
array of int64s

Specify the IDs of admins you wish to list.

adminIDs
emails
array of strings

Specify the emails of admins you wish to list.

emails
roleIDs
array of int64s

Specify the role IDs of admins you wish to list.

  • 2 - MSP Admin
  • 3 - Tenant Admin
  • 4 - Read Only Admin
roleIDs
Headers
string
required

Specify the Bearer access token

Responses

400

Bad Request

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