For the complete documentation index, see llms.txt. This page is also available as Markdown.

User organization roles

User organization roles define user permissions in the organization. The endpoints discussed further retrieve information about user roles in the organization. Use the /users/{userId}/user-organization-roles/{organizationIdId} to manage user organization roles. Check out the overview of user organization roles and the associated user permissions.

List user roles

get
/organizations/{organizationId}/user-organization-roles

Retrieves information about all users and their roles in the organization with the specified organizationId.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Query parameters
Responses
200

Successful response

application/json
get/organizations/{organizationId}/user-organization-roles
200

Successful response

Get user organization role details

get
/organizations/{organizationId}/user-organization-roles/{userId}

Retrieves information about a user role in an organization with the specified userId and organizationId. Get all user role IDs with the API call GET users/roles.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
userIdintegerRequired

The ID of the user.

Example: 111
Query parameters
Responses
200

Successful response

application/json
get/organizations/{organizationId}/user-organization-roles/{userId}
200

Successful response

Transfer organization ownership

post
/organizations/{organizationId}/user-organization-roles/transfer

Transfer organization ownership to the specified user. Only the user that has the user role "Owner" in the organization can transfer ownership.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Body
userIdintegerRequired

The ID of the user.

Responses
200

Successful response

application/json
post/organizations/{organizationId}/user-organization-roles/transfer
200

Successful response

Last updated