Get Role
GET /roles/{role_id}
GET
/roles/{role_id}
One role, with the full permission list it grants.
Authorizations
Parameters
Path Parameters
role_id
required
Role id (UUID).
string
Role id (UUID).
Header Parameters
Responses
200
Successful Response
object
data
required
An open envelope for a single role, team, member or account record.
Open on purpose. The app’s own response models on this surface grow with
the product - RoleResponse gained rep_limits and manages_role_slugs,
TeamResponse gained channel counts and a campaign count - and a pinned
mirror would SILENTLY DROP whatever it had not caught up on. A dropped
permission in a role read is the worst possible kind of stale: it reads as
“they do not have it”.
object
key
additional properties
any
pagination
Any of:
object
has_next
required
Whether there are more pages
boolean
limit
required
Items per page
integer
notes
Any of:
Array<string>
null
page
required
Current page number (1-indexed)
integer
total
required
Total number of items
integer
null
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string