The organization object
string
Unique id (e.g.
org_01H...).string
Display name.
integer
Current credit balance, in micro-USD.
string
Creation timestamp.
Create an organization
POST /v1/organizations → 201 Created
The only write that is not scoped to an organization — it is how an existing caller gets another one. Authenticate with either an admin API key or a signed-in user session; an unauthenticated call is refused with 401. Your first organization comes from signing up, not from this route.
string
required
Display name for the organization.
Response
admin key that opens it, whose secret is returned here and never again. A caller signed in as a person also becomes the founding owner.
List, retrieve & update
GET /v1/organizations is orgless — it answers on a user session rather than an org-scoped key, which is what makes org switching possible. See Authentication.
Response
Update an organization
PATCH /v1/organizations/{id}
string
required
New display name.
Members
Users belong to an organization with a role that controls what they can do.The member object
string
Member id (e.g.
usr_01H...). It is the id the member routes address and the id the audit log records as the actor.string
The member’s email address.
string
owner | admin | member.string | null
Id of the member who invited them;
null for the founding owner.string
When the member joined the organization.
List members
GET /v1/organizations/{id}/members — cursor-paginated. See Pagination.
Response
Add a member
POST /v1/organizations/{id}/members
string
required
Email address to invite.
string
required
owner | admin | member.Response
Update a member’s role
PATCH /v1/organizations/{id}/members/{member_id}
string
required
owner | admin | member.Remove a member
DELETE /v1/organizations/{id}/members/{member_id}
Both mutations are recorded in the audit log as member.role_changed and member.removed, attributed to the acting principal.
API keys
Programmatic access uses org-scoped API keys, managed under/v1/api_keys. For creation, scopes, and rotation, see Authentication.
Credits & billing
The org’s real-USD balance, ledger, and top-ups.