Hexel StudioDocs

List roles

GET/roles

List roles filtered by organization and scope

Query parameters

organization_idoptional string

Organization ID

scopeoptional string

Scope (system, custom)

Headers

Authorizationstring

Bearer <token>.

Returns

200OKarray of Role

boundary_idoptional string

created_atoptional string

created_by_user_idoptional string

descriptionoptional string

display_namestring

environment_idoptional string

idoptional string

is_enabledoptional boolean

is_systemoptional boolean

max_session_durationoptional integer

namestring

organization_idoptional string

role_typeoptional string

Assumable-role fields (migration 027).

scopestring

One of: "organization", "workspace", "environment", "platform"

trust_policyoptional object

updated_atoptional string

workspace_idoptional string

Errors

500Internal Server Error

GET Request

curl --request GET \
  --url 'https://api.hexelstudio.com/v1/roles' \
  --header "Authorization: Bearer $ACCESS_TOKEN"

const res = await fetch("https://api.hexelstudio.com/v1/roles", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.ACCESS_TOKEN}`,
  },
})
const data = await res.json()

import os
import requests

res = requests.get(
    "https://api.hexelstudio.com/v1/roles",
    headers={"Authorization": f"Bearer {os.environ['ACCESS_TOKEN']}"},
)
data = res.json()

Response

[
  {
    "boundary_id": "string",
    "created_at": "2026-01-01T00:00:00Z",
    "created_by_user_id": "string",
    "description": "string",
    "display_name": "string",
    "environment_id": "string",
    "id": "string",
    "is_enabled": true,
    "is_system": true,
    "max_session_duration": 0,
    "name": "string",
    "organization_id": "string",
    "role_type": "string",
    "scope": "organization",
    "trust_policy": {},
    "updated_at": "2026-01-01T00:00:00Z",
    "workspace_id": "string"
  }
]

{
  "key": "string"
}