Organization API reference

Organization API.

10 endpoints, 4 of them read-only. Every one is also a command in the orbit CLI, a method in the SDKs and a tool on the MCP server.

01

General

EndpointScopeParametersCLI · MCP tool
GET /org
This account's organisation, created on first read
read—orbit org get
org_get
PATCH /org
Rename the organisation or change its handle
writebody: name string, slug stringorbit org patch
org_patch
02

members

EndpointScopeParametersCLI · MCP tool
GET /org/members
Everybody in the organisation, the owner included
read—orbit org members list
org_members_list
POST /org/members
Invite somebody by email. Sending again to the same address replaces the previous link.
writebody: email* string, role admin | memberorbit org members invite
org_members_invite
PATCH /org/members/{sub}
Change somebody's role, or suspend and restore them
writesub string
body: role admin | member, state active | suspended
orbit org members patch <sub>
org_members_patch
DELETE /org/members/{sub}
Remove somebody from the organisation
writesub stringorbit org members remove <sub>
org_members_remove
03

invites

EndpointScopeParametersCLI · MCP tool
GET /org/invites
Invitations that have not been accepted yet
read—orbit org invites list
org_invites_list
DELETE /org/invites/{id}
Revoke an invitation; its link stops working now
writeid stringorbit org invites revoke <id>
org_invites_revoke
04

apps

EndpointScopeParametersCLI · MCP tool
PATCH /org/apps
Turn applications on and off for everybody in the organisation
writebody: mail boolean, meet boolean, chat boolean, drive booleanorbit org apps patch
org_apps_patch
05

domains

EndpointScopeParametersCLI · MCP tool
GET /org/domains
Domains this organisation works under, and whether each is verified
read—orbit org domains list
org_domains_list
Next

Related

Account API reference

Every Account endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Services API reference

Every Services endpoint in the Orbit API (15): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

DNS API reference

Every DNS endpoint in the Orbit API (30): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

← All documentation