Get List Of Roles

Access: read-only. Available to read-only API credentials.

Retrieve the list of user roles defined for your account.

When to use. Populate a role picker, or look up a role's id, level or two-factor setting before assigning it to a user. To fetch a single role by its id, use GET /roles/{id}.

Parameters. Filter, order, limit and select fields by any response field. Select userIds to include the IDs of the users assigned to each role.

Returns. { "roles": [ ... ] }, where each entry has id, name, level, twofa_type and, by default, userIds.

Example. GET /api/roles

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Dialer Name (subdomain)

Responses

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