v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Governance Hierarchy

Get a list of governance nodes

Queries the customer's governance hierarchy tree, returning a cursor-paginated list of nodes with their usage configuration (limit, cadence, scope) and current usage, sortable and filterable by usage. Each node carries parentId so the tree can be rebuilt client-side. Usage is read from a periodically-refreshed read model and never gates access.

get/api/v1-beta/customers/{id}/governance

Path parameters

idstring required

The customer ID.

Query parameters

limitinteger

Maximum number of items to return

afterstring

Return items that come after this cursor

featureIdsstring[]

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.

currencyIdsstring[]

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

sortBy'utilization' | 'currentUsage' | 'usageLimit' | 'scopeSize' | 'id' | 'createdAt'

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

order'asc' | 'desc'

Sort direction: asc or desc (default desc).

scope'all' | 'nodeWide' | 'scoped'

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

minUtilizationnumber

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

entityTypeIdsstring[]

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

entityIdSearchstring

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

Headers

X-ACCOUNT-IDstring

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-IDstring

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).

Response

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