Skip to main content

Organization API

Manage your organization's profile, plan information, and membership roster.

Authentication: session token only (Authorization: Bearer <session_token>).

Looking for governance defaults?

Org-wide governance settings — default verdict mode, model allow/block lists, default spend caps, emergency kill switch — live on the Governance Controls API, not here.


Endpoints

MethodPathPermission
GET/v1/organizationorganization:read
PATCH/v1/organizationorganization:update
GET/v1/organization/usersusers:read

GET /v1/organization

{
"organization_id": "org_01JF8RORG1A2B3C4D5E6F7G8H9I",
"organization_name": "Acme Corp",
"plan": "pro",
"status": "active",
"domain": "acmecorp.com",
"created_at": "2024-11-01T00:00:00Z"
}
FieldTypeDescription
organization_idstringUnique identifier (org_*)
organization_namestringDisplay name
planstringstarter, pro, or enterprise
statusstringactive or suspended
domainstring | nullVerified primary domain, if configured
created_atRFC 3339When the organization was created

PATCH /v1/organization

Partial update.

{
"organization_name": "Acme Corporation",
"domain": "acmecorp.com"
}
FieldTypeDescription
organization_namestringUpdated display name
domainstringPrimary domain — must be DNS-verifiable

Returns the updated organization object.


GET /v1/organization/users

A lightweight membership roster for the org. Useful for building admin dashboards or external user-sync workflows. The full per-user CRUD surface (and offset pagination) is on the Users API.

{
"users": [
{
"user_id": "usr_01JF8RUS1A2B3C4D5E6F7G8H9I",
"email": "jane.doe@yourcompany.com",
"display_name": "Jane Doe",
"roles": ["admin"],
"status": "active",
"last_login_at": "2026-04-30T09:30:00Z"
}
],
"total": 12
}
Pagination shape

/v1/organization/users returns a flat total count, no cursor. For paged access use GET /v1/users (offset pagination).


Errors

HTTPerror.codeCause
400validation_errorBody or query failed schema validation
401unauthenticatedMissing or invalid session token
403forbiddenInsufficient permissions

Next steps