Skip to main content
List the company’s permission roles, ordered by name, with how many non-archived users hold each. A role decides what a user may see and do; use get_role for the permissions behind one. Reach for this to answer questions about the shape of the organization’s access: how many people are admins, which roles exist, which one new users get by default. Each row also says whether the role is the built-in Admin. Qobra support’s own god role is never listed.
This tool needs the permission to read the roles settings. The web app does not require it for a caller merely reading role names, but an organization’s permission structure is administrative data, and gating it like get_role means a caller who can list a role can always read it.

​
Parameters

Body

​
string
Part of the name, matched as one phrase ignoring case and accents, or a role id (an unknown id lists nothing).
​
integer
Rows per page, 1 to 250. Default 50.
​
integer
Rows to skip. Omit it for the first page, never null or the string ‘None’; for the next page pass the previous next_offset.

​
Response

Body

​
object[]
​
integer