Organizations
- Written for
- + Written for
- Deprecated
- + Deprecated
- Applies to
- + Applies to
Organizations
Backend API — secret key (Authorization: Bearer sk_…).
23 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.
Method & path | Scope | Idem | Explanation |
|---|---|---|---|
|
| List organizations, cursor-paginated. | |
|
| Create an organization and seat its creator as admin. | |
|
| Fetch an organization. Never includes private_metadata. | |
|
| List members of an organization with their roles. | |
|
| Change a member's role. Demoting the last admin returns LAST_ADMIN. | |
|
| Remove a member. Removing the last admin returns LAST_ADMIN. | |
|
| Invite an email address to an organization. Expires in 7 days. | |
|
| Revoke a pending invitation so the address can be re-invited. | |
|
| Update the org security policy (requireMfa, ssoRequired, sessionIdleOverrideMs). | |
|
| Grant an org role to a directory group; members inherit its permissions (augments only). | |
|
| Revoke a role from a directory group. Members lose the inherited permissions. | |
|
| ✓ | Update an organization name, slug, image, seat cap or metadata. Emits organization.updated. |
|
| ✓ | Delete an organization; its memberships and invitations cascade with it. |
|
| Set or clear (null) an organization’s parent in the B2B2B hierarchy; refuses a cycle. | |
|
| The organization’s ancestor chain and direct children in the B2B2B hierarchy. | |
|
| The organization’s resolved entitlement plan and feature keys. | |
|
| ✓ | Replace the organization public and private metadata bags wholesale. |
|
| ✓ | Add an existing instance user to an organization with a role. The seat cap is enforced. |
|
| List an organization's invitations with their roles and status. | |
|
| List an organization's email domains and their verification state. | |
|
| ✓ | Claim an email domain for auto-join. Returns the DNS TXT record to publish. |
|
| Check the DNS TXT record now and mark the domain verified. | |
|
| Remove a claimed email domain. |