Developer APIResourcesRoles

List custom roles

Lists all custom roles.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

Page number of the custom roles to fetch. Defaults to 1.

per_pageintegerOptional

Number of custom roles to return in a single page. Defaults to 100. Max is 100.

role_namestringOptional
Filter by role name.

Response

Array of roles with privileges and metadata
idinteger or null
The unique identifier of the role.
namestring or null
The name of the role.
inheritableboolean or null
Indicates whether the role is inheritable.
folder_idslist of integers or null
Array of folder IDs associated with the role. Empty if none are assigned.
created_atstring or null
The timestamp when the role was created.
updated_atstring or null
The timestamp when the role was last updated.
privilegesmap from strings to lists of strings or null
An object containing privileges associated with the role.

Errors