v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Roles

List roles

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

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

get/v2/roles

Query parameters

limitinteger

Maximum items to return

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.