Skip to main content
GET
Error

Authorizations

X-API-Key
string
header
required

Query Parameters

sort_by
enum<string>[] | null

Fields to sort by, applied in the order supplied within existing scope and built-in role priorities. Repeat this parameter for multiple fields. Omit to preserve the default ordering.

Available options:
display_name,
created_at
sort_order
enum<string>[] | null

Sort directions corresponding positionally to sort_by fields. Supply one direction for all fields, or repeat this parameter once per field. Omit to sort all requested fields ascending. Ignored when sort_by is omitted. Scope and built-in role priorities are unchanged.

Available options:
asc,
desc

Response

Successful Response

id
string<uuid>
required
name
string
required
display_name
string
required
description
string
required
permissions
string[]
required
organization_id
string<uuid> | null
access_scope
enum<string> | null
Available options:
organization,
workspace
is_restricted
boolean
default:false