Sign in
Roles

List roles

List custom and predefined roles for the authenticated user's account. Results are paginated; use limit and cursor for subsequent pages.

Account admins, members, and other callers with ROLE_READ receive each role's full permission list. Callers without ROLE_READ are rejected with 403.

<Note>This endpoint is in beta, read more here.</Note>

get/v2/roles

Query parameters

limitinteger

Maximum items to return. Defaults to 50 if omitted; maximum is 100.

cursorstring

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

is_predefinedboolean

Filter roles by predefined status.

  • true - Return only system-defined predefined roles.
  • false - Return only custom (account-defined) roles.

When not specified, returns all roles (both predefined and custom).

Response

Returns a list of role objects.

Changes

Changed in 2 of the 16 revisions of this API.8

  • c26a00e9b3184See the full diff
    • ●

      added the new AGENT_ROLE_CREATE enum value to the roles/items/permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AGENT_ROLE_DELETE enum value to the roles/items/permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AGENT_ROLE_READ enum value to the roles/items/permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AGENT_ROLE_UPDATE enum value to the roles/items/permissions/items/ response property for the response status 200

      response-property-enum-value-added

  • ddf93df2c2954See the full diff
    • ●

      added the new ROLE_CREATE enum value to the roles/items/permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ROLE_DELETE enum value to the roles/items/permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ROLE_READ enum value to the roles/items/permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ROLE_UPDATE enum value to the roles/items/permissions/items/ response property for the response status 200

      response-property-enum-value-added

Of the 16 revisions, 1 has no diff computed.