List administrators
/administratorsLists 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Query Parameters
1 <= value <= 200Response Body
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": "[email protected]", "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" }}Administrators
Administrators in API v3: list administrators, create an administrator, retrieve an administrator, update an administrator, delete an administrator, resend the access email, retrieve administrator permissions, update administrator permissions.
Create an administrator POST
Creates an administrator in the current account. By default, the new administrator receives an access email. Set `send_credentials` to `false` to skip it. You can assign granular permissions and product access in the same request with `permissions` and `product_ids`, which also requires the `administrators.manage_permissions` permission. When either field is supplied, the administrator receives only the permissions listed in `permissions` instead of the role's default permissions. If any part of the request is rejected, no administrator is created. The API cannot create administrators with the `root` or `master_admin` role, and creating an administrator with the `admin` role requires the `administrators.manage_permissions` permission. Every permission granted in `permissions` must be part of the selected role's default permissions. Requests that exceed these limits return `delegation_limit_exceeded`.