v1
latestOpenAPI 3.0.02026-07-23620132.5 KBUser role definitions
Gets list of all existing user role names and IDs. Optionally filter by category, a specific roleId, or pass organizationId/teamId to include custom roles for that organization. Set the user roles in an organization with the POST /users/{userId}/user-organization-roles/{organizationId} API call. Use the POST /users/{userId}/user-team-roles/{teamId} API call to set user roles in a team.
Query parameters
Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.
Check the "Filtering" section for a full example.
Set this parameter to organization or team to get user roles in an organization or in a team.
Include custom roles belonging to this organization. Can be combined with teamId; if both are provided and the team does not belong to the organization, the request returns 400. If the organization does not have the customRoles license, or the caller lacks permission to view that organization's users, custom roles are silently excluded from the response while the system roles are still returned.
Include custom roles belonging to the organization that owns this team. Can be combined with organizationId; if both are provided and the team does not belong to the organization, the request returns 400. If the organization does not have the customRoles license, or the caller lacks permission to view that organization's users, custom roles are silently excluded from the response while the system roles are still returned.
Filter the response to a single role by its ID.
Exclude roles with these IDs from the response.
Response
Successful response