Query parameters
Sort roles by name. Use -name for descending order. Ties are ordered by ID, and any other value is ignored. Without it, built-in roles come first, then custom roles.
Headers
Bearer $TOKEN
Lists all roles in your organization β the five built-in roles (admin, billing_admin, team_lead, responder, member) and any custom roles. Use a role's id with the Update team member role or Invite team member APIs.
The role attribute is the system-role identifier, or custom for a custom role. Custom roles share the value custom, so identify them by their id and name. See Manage roles
for what each built-in role can access.
Roles are organization-scoped, so no team_name is required. A global API token spanning multiple teams lists the organization's roles directly. The endpoint is not paginated, so a single response always contains every role.
Query parameters
Sort roles by name. Use -name for descending order. Ties are ordered by ID, and any other value is ignored. Without it, built-in roles come first, then custom roles.
Headers
Bearer $TOKEN
Returns the organization's roles.
Response body
Authentication failed due to a missing or invalid token.
Response body
Response attributes
The ID of the role, which you pass as role_id.
Always role.
The name of the role.
admin, billing_admin, team_lead, responder, or member for a built-in role, or custom for a custom role.
We use cookies to authenticate users, improve the product user experience, and for personalized ads. Learn more.