Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Path Parameters

id
string
required

The customer ID.

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$

Query Parameters

limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
after
string

Return items that come after this cursor

Maximum string length: 255
featureIds
string[]

Feature ids to include, repeated per value (e.g. ?featureIds=ai-tokens&featureIds=seats). Omit both featureIds and currencyIds for tree mode — every node in the hierarchy with no usage configuration attached.

currencyIds
string[]

Currency ids to include, repeated per value (e.g. ?currencyIds=credits). Omit both featureIds and currencyIds for tree mode.

sortBy
enum<string>
default:utilization

Sort key: utilization (default, cross-capability-safe), currentUsage, usageLimit, scopeSize, id, or createdAt.

Available options:
utilization,
currentUsage,
usageLimit,
scopeSize,
id,
createdAt
order
enum<string>
default:desc

Sort direction: asc or desc (default desc).

Available options:
asc,
desc
scope
enum<string>
default:all

Filter by configuration scope: all (default), nodeWide ([] only), or scoped (non-empty only).

Available options:
all,
nodeWide,
scoped
minUtilization
number

Only nodes with utilization ≥ this value (e.g. 0.8 for ≥80%, 1 for at/over limit).

Required range: x >= 0
entityTypeIds
string[]

Filter to one or more entity types, repeated per value (e.g. ?entityTypeIds=team&entityTypeIds=user).

Case-insensitive substring match on the entity id (%/_ matched literally).

Required string length: 1 - 255

Response

A paginated list of governance tree nodes with usage configuration and current usage.

Paginated list of governance tree nodes, each with its usage configuration and current usage.

data
GovernanceNode · object[]
required
pagination
object
required