List roles
Authorization
bearerAuth In: header
Query Parameters
Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.
Comma-separated list of attributes to sort by. Prefix with - for
descending order (-created_at,family_name).
Offset pagination parameters.
Keys take the form filter[<attribute>_<predicate>]=<value>, repeatable per query.
Common predicates by attribute type:
- String / text / uuid:
eq,not_eq,cont,not_cont,matches,start,end,present,blank,null,not_null,in,not_in - Integer / decimal / date / datetime:
eq,not_eq,gt,gteq,lt,lteq,present,blank,null,not_null,in,not_in - Boolean:
eq,not_eq,present,blank,null,not_null
_in / _not_in accept comma-separated values or repeated keys.
Roles also expose the virtual predicates global_eq and
role_summary_id_eq (the latter takes a Base64-encoded role name).
Example: ?filter[name_eq]=member&filter[global_eq]=true
Sparse-fieldset selection.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/roles"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "roles", "attributes": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "name": "string", "description": "string", "slug": "string", "global": true, "automated": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "relationships": { "resource": { "data": { "type": "organizations", "id": "string" }, "links": { "self": "/roles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/resource", "related": "/roles/7247ad7d-9275-454b-9e3a-0570e403739e/resource" } }, "role_summary": { "data": { "type": "role_summaries", "id": "string" }, "links": { "self": "/roles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/role_summary", "related": "/roles/7247ad7d-9275-454b-9e3a-0570e403739e/role_summary" } }, "people": { "data": [ { "type": "people", "id": "string" } ], "links": { "self": "/roles/7247ad7d-9275-454b-9e3a-0570e403739e/relationships/people", "related": "/roles/7247ad7d-9275-454b-9e3a-0570e403739e/people" } } } } ], "meta": { "page": { "total_items": 0, "total_pages": 0, "number": 0, "size": 0 } }}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}