All endpoints on this page are [User] — they require a signed-in user session and are not available to API keys. See Authentication.
Roles
Members hold one role per organization, which determines what they can do:| Role | Can do |
|---|---|
owner | Everything, including deleting the organization and changing roles. |
billing_admin | Manage billing and most administration below ownership. |
developer | Work with environments, tenants, and content. |
viewer | Read-only access. |
Endpoints
| Method | Path | Description | Auth |
|---|---|---|---|
GET | /organizations | List organizations the user belongs to, with role | [User] |
GET | /organizations/:id | Get a single organization | [User] |
POST | /organizations | Create an organization | [User] |
PATCH | /organizations/:id | Update name or status | [User] |
DELETE | /organizations/:id | Delete an organization | [User] |
GET | /organizations/:id/members | List members and pending invites | [User] |
POST | /organizations/:id/members | Invite a member by email | [User] |
POST | /organizations/:id/members/role | Assign or change a member’s role | [User] |
DELETE | /organizations/:id/members/:member_id | Remove a member | [User] |
DELETE | /organizations/:id/invites/:invite_id | Revoke a pending invite | [User] |
List organizations
GET /organizations
Returns every organization the signed-in user belongs to, each with the user’s role in it.
Get an organization
GET /organizations/:id
The organization ID.
Create an organization
POST /organizations
Creates an organization and auto-provisions a default environment, a default tenant inside it, and a starting credit balance — so you can begin working immediately.
Display name for the organization.
Unique URL-safe slug using lowercase letters, numbers, and hyphens.
business or personal. Defaults to business.Update an organization
PATCH /organizations/:id
Updates the organization’s name or status. Requires an administrative role.
The organization ID.
New display name.
New status —
active, inactive, or suspended.Delete an organization
DELETE /organizations/:id
Permanently deletes the organization and everything under it.
The organization ID.
List members
GET /organizations/:id/members
Returns the organization’s active members (with their roles) and any pending invitations.
The organization ID.
Invite a member
POST /organizations/:id/members
Sends an invitation to an email address with an assigned role. The invitee accepts through the invites flow.
The organization ID.
Email address to invite.
Role to grant on acceptance —
billing_admin, developer, or viewer. Defaults to viewer; ownership is assigned separately after the user joins.Only the
owner may invite members. Invitations expire after 7 days — see Invites.Assign a role
POST /organizations/:id/members/role
Changes an existing member’s role.
The organization ID.
The member’s user ID.
The new role — one of
owner, billing_admin, developer, viewer.Remove a member
DELETE /organizations/:id/members/:member_id
Removes a member from the organization, revoking their access immediately.
The organization ID.
The member’s user ID.
Only the
owner may remove members.Revoke an invite
DELETE /organizations/:id/invites/:invite_id
Cancels a pending invitation before it is accepted.
The organization ID.
The pending invitation ID.
Only the
owner may revoke invitations.Next steps
Members & roles
Understand exactly what each role can do.
Environments
Add environments to isolate dev, staging, and production.
Invites
See how invitees accept and join.