Skip to main content
GET
List the roles assignable on a business account

Authorizations

Authorization
string
header
required

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

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

businessAccountId
string
required

ID of the business account

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Response

The assignable roles on this account

The SDK roles response plus the built-in roles that are assignable on every account, so a role picker needs no hardcoded list. owner is not listed — ownership moves only by transfer.

roles
object
required

Customer-defined roles keyed by role name.

builtInRoles
enum<string>[]
required
Available options:
admin,
viewer
Last modified on October 8, 2026