Organizations

Most resources in the API are scoped to a single organization. These endpoints manage the org itself, its members, and the roles that gate permissions.

Resource overview

GET/api/organizationsSessionRole: Super Admin

GET/api/organizations/meAPI key · Session

PATCH/api/organizations/meAPI key · SessionRole: Admin

GET/api/organizations/me/permissionsAPI key · Session

GET/api/organizations/{id}SessionRole: Super Admin

PATCH/api/organizations/{id}SessionRole: Super Admin

DELETE/api/organizations/{id}SessionRole: Super Admin

Current organization

GET/api/organizations/meAPI key · Session

Returns the org backing the current session/API key.

PATCH/api/organizations/meAPI key · SessionRole: Admin

Name	Type	Required	Description
`name`	`string`	Optional	Display name.
`logo`	`string (url)`	Optional	Logo URL.
`timezone`	`string`	Optional	IANA timezone, e.g. `America/Los_Angeles`.

My permissions

GET/api/organizations/me/permissionsAPI key · Session

Returns the permission map for the calling user's role, useful for client-side gating.

Members

GET/api/organizations/membersAPI key · SessionPermissions: users.read

PATCH/api/organizations/members/{memberId}API key · SessionPermissions: users.update

DELETE/api/organizations/members/{memberId}API key · SessionPermissions: users.delete

Roles

GET/api/organizations/rolesAPI key · SessionPermissions: roles.read

POST/api/organizations/rolesAPI key · SessionPermissions: roles.create

PATCH/api/organizations/roles/{id}API key · SessionPermissions: roles.update

DELETE/api/organizations/roles/{id}API key · SessionPermissions: roles.delete

Org-scoped roles shadow system roles of the same name.

Invitations (org-level)

GET/api/organizations/invitationsAPI key · SessionPermissions: users.read

POST/api/organizations/invitationsAPI key · SessionPermissions: users.invite

POST/api/organizations/invitations/{id}API key · SessionPermissions: users.invite

DELETE/api/organizations/invitations/{id}API key · SessionPermissions: users.invite

POST /{id} resends the invite email. DELETE /{id} revokes a pending invitation. To accept an invite as the recipient, see Invitations.