Roles

get
Authorizations
AuthorizationstringRequired

Authenticate using Bearer <jwt> format for internal endpoints

Query parameters
searchstringOptional

A search term.

orderingstringOptional

Which field to use when ordering the results.

role_typestring · enumOptional

role_type

Possible values:
is_primarystringOptional

is_primary

organizationstringOptional

organization

personstringOptional

person

pageintegerOptional

Page number to retrieve (1-indexed).

page_sizeintegerOptional

Number of results per page. Defaults to the pagination class's page size and respects the configured maximum.

Responses
chevron-right
200Success
application/json
countintegerRequired
nextstring · uri · nullableOptional
previousstring · uri · nullableOptional
get
/roles/
200Success
get
Authorizations
AuthorizationstringRequired

Authenticate using Bearer <jwt> format for internal endpoints

Path parameters
idstringRequired
Responses
chevron-right
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
titlestring · min: 1Read-onlyOptional
start_datestring · dateRead-onlyOptional
end_datestring · date · nullableRead-onlyOptional
is_primarybooleanRead-onlyOptional
role_typestring · enumRead-onlyOptionalPossible values:
createdstring · date-timeRead-onlyOptional
modifiedstring · date-timeRead-onlyOptional
get
/roles/{id}/
200Success

Last updated