get_role for the
permissions behind one. Reach for this to answer questions about the shape of
the organisation’s access — how many people are admins, which roles exist, which
one new users get by default. Rows are ordered alphabetically by role name
(A→Z).
Qobra support’s own god role is never listed, and the headcount counts
non-archived users only.
This tool needs the company-settings roles permission (READ on the Role
company setting). The web app does not require it for a caller merely reading
role names, but an organisation’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
Body
string
Filter matched against the role name (case-insensitive substring) or, when
it is a valid ObjectId, against the role id.
integer
Page size, between 1 and 250. Defaults to 50.
integer
Row offset into the result set — the number of rows to skip before this
page. Any offset >= 0 is accepted; it does not have to be a multiple of
limit, so you can start from an arbitrary row. Pass the next_offset returned
by the previous call to walk the pages, or None for the first page.