Organization and team role definitions.
/org/rolesList organization roles
Returns all roles available within the organization, including their names and descriptions. Organization roles define the permissions a member has at the organization level.
Parameters
pageinteger
The page number to retrieve (1-indexed). Used with limit to support offset-based pagination.
"int32"11limitinteger
The maximum number of items to list.
"int32"0100100searchstring
Search term to filter results. Searches across relevant text fields like names and descriptions.
""sortBystring
The field to sort by.
"name""name"sortDirectionstring
The direction to sort (ascending or descending).
"asc""desc""asc"Responses
Responses
A list of organization roles is returned.
/org/roles/{role}Describe an organization role
Retrieves detailed information about a specific organization role, including all assigned permissions and permission bundles.
Parameters
rolestringrequired
The organization role ID.
"A1B2C3D4E5"120"^[A-Z0-9]{1,20}$"Responses
Responses
Organization role details retrieved successfully
/org/team-rolesList team roles
Returns all team roles within the organization that can be assigned to team members.
Parameters
pageinteger
The page number to retrieve (1-indexed). Used with limit to support offset-based pagination.
"int32"11limitinteger
The maximum number of items to list.
"int32"0100100searchstring
Search term to filter results. Searches across relevant text fields like names and descriptions.
""sortBystring
The field to sort by.
"name""name"sortDirectionstring
The direction to sort (ascending or descending).
"asc""desc""asc"Responses
Responses
A list of team roles is returned.
/org/team-roles/{role}Describe a team role
Retrieves detailed information about a specific team role, including all assigned permissions and permission bundles.
Parameters
rolestringrequired
The ID of the team role.
Responses
Responses
Team role details retrieved successfully