Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Admins

List all administrators

Returns the list of admins with their details.

get/msp/v2/admins

Query parameters

pageTokenstring
  • The token to access the next page of results. Use the token value received in the previous response's parameter 'nextPageToken'.
  • Keep this field blank in the first request.
pageSizeinteger

Specify the number of records you want to receive in the API response. Example-30

idinteger[]

Specify the admin IDs you want to list, separated by commas. Example - 1,2

emailstring[]

Specify the email addresses of the admins you wish to list, separated by commas. Example- email@example.com, email1@example.com

roleinteger[]

Specify the role IDs of admins you wish to list, separated by commas. Example- 2, 4

  • 2 - MSP Admin
  • 3 - Tenant Admin
  • 4 - Read Only Admin

Headers

Authorizationstring required

Specify the Bearer access token

Response

Ok

nextPageTokenstring

Example response

{
  "admins": [
    {
      "email": "email@example.com",
      "firstName": "John",
      "id": 1,
      "lastName": "Smith",
      "phone": "12345678910",
      "timezone": "Asia/Kolkata",
      "status": 1,
      "role": 2,
      "active": true,
      "createdBy": 123,
      "lastLogin": "2024-12-24T10:48:56.361Z"
    }
  ]
}