List administrators

GET/administrators

Lists the administrators in the current account using cursor-based pagination.

By default, only active administrators are returned. Set deleted to true to list only administrators in the trash. Use q to search by name or email address (case-insensitive partial match) and role to filter by role.

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

q?string

Text search term.

role?string

Only administrators with this role.

deleted?boolean

When true, returns only items in the trash. Items in the trash are excluded by default.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/administrators"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "deleted": true,      "email": "user@example.com",      "id": "string",      "last_login_at": "2019-08-24T14:15:22Z",      "name": "string",      "object": "administrator",      "product_ids": [        "string"      ],      "revision": "string",      "role": "root",      "status": "active",      "two_factor_enabled": true,      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}