Skip to main content
GET
List Requestable Roles

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.
  • Your own requestable roles: target_user_id must be omitted or be your own user ID.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

teamId
string
required

The ID of the workspace. Required.

targetUserId
string

The ID of the user to check requestable roles for. Defaults to the authenticated user if omitted.

pageSize
integer<int32>

Maximum number of results to return. Default is 100, maximum is 1000.

pageToken
string

Token for pagination. Leave empty for the first request.

Response

200 - application/json

Success

data
RequestableRole · object[]

The list of requestable roles with their access policies.

nextPageToken
string | null

Token for retrieving the next page of results. Empty if no more results.