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.
33 endpoints, 13 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.
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /orgThis account's organisation, created on first read | read | — | orbit org getorg_get |
PATCH /orgRename the organisation or change its handle | write | body: name string, slug string | orbit org patchorg_patch |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /org/membersEverybody in the organisation, the owner included | read | — | orbit org members listorg_members_list |
POST /org/membersInvite somebody by email. Sending again to the same address replaces the previous link. | write | body: email* string, role admin | member | guest, template_ids string[] | orbit org members inviteorg_members_invite |
PATCH /org/members/{sub}Change somebody's role, or suspend and restore them | write | sub stringbody: role admin | member | guest, state active | suspended | orbit org members patch <sub>org_members_patch |
DELETE /org/members/{sub}Remove somebody from the organisation (offboarding with the default modes; restorable for 30 days) | write | sub string | orbit org members remove <sub>org_members_remove |
GET /org/members/{sub}/bindingsA member's (role, scope) bindings | read | sub string | orbit org members bindings list <sub>org_members_bindings_list |
POST /org/members/{sub}/bindingsGive a member a role on the organisation or on a group; joining a group gives what it carries | write | sub stringbody: role* string, scope_id string | orbit org members bindings add <sub>org_members_bindings_add |
POST /org/members/{sub}/bindings/removeRemove a binding; what that group gave is taken back | write | sub stringbody: role* string, scope_id string | orbit org members bindings remove <sub>org_members_bindings_remove |
GET /org/members/{sub}/assignmentsWhat a member has been given in each product | read | sub string?all 1 | orbit org members assignments list <sub>org_members_assignments_list |
POST /org/members/{sub}/assignmentsGive a member one item (a mailbox, an extension, a shared drive, …); runs as a job | write | sub stringbody: product* mail | voice | drive | chat | meet | helpdesk, kind* mailbox | mail_group | mailbox_access | extension | ring_group | shared_drive | drive_quota | chat_space | meet_host | helpdesk_seat, domain_id integer, local string, quota_gb number, group_id string, mailbox_id string, perm full | read, pbx_id string, range string, drive_id string, role string, gb integer, space_id string, readonly boolean, department_id integer | orbit org members assign <sub>org_members_assign |
POST /org/members/{sub}/templatesApply role templates to a member (preview: true to see the plan first) | write | sub stringbody: template_ids* string[], preview boolean | orbit org members templates <sub>org_members_templates |
POST /org/members/{sub}/offboardRemove a member: every assignment goes where its mode says; restorable for 30 days (preview: true lists the items and modes) | write | sub stringbody: preview boolean, modes object | orbit org members offboard <sub>org_members_offboard |
POST /org/members/{sub}/restoreRestore a member removed less than 30 days ago, with everything they had | write | sub string | orbit org members restore <sub>org_members_restore |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /org/invitesInvitations that have not been accepted yet | read | — | orbit org invites listorg_invites_list |
DELETE /org/invites/{id}Revoke an invitation; its link stops working now | write | id string | orbit org invites revoke <id>org_invites_revoke |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
PATCH /org/appsTurn applications on and off for everybody in the organisation | write | body: mail boolean, meet boolean, chat boolean, drive boolean | orbit org apps patchorg_apps_patch |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /org/domainsDomains this organisation works under, and whether each is verified | read | — | orbit org domains listorg_domains_list |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /orgsEvery organisation this account belongs to | read | — | orbit org orgs listorg_orgs_list |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /org/groupsGroups and departments (a tree of at most three levels) | read | — | orbit org groups listorg_groups_list |
POST /org/groupsCreate a group, or a department inside one | write | body: name* string, parent_id string, description string | orbit org groups createorg_groups_create |
PATCH /org/groups/{id}Rename a group or change what it gives its members | write | id stringbody: name string, description string, links object | orbit org groups patch <id>org_groups_patch |
DELETE /org/groups/{id}Delete an empty group | write | id string | orbit org groups delete <id>org_groups_delete |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /org/templatesRole templates | read | — | orbit org templates listorg_templates_list |
POST /org/templatesCreate a role template | write | body: name* string, description string, spec object | orbit org templates createorg_templates_create |
PATCH /org/templates/{id}Replace a role template's name and items | write | id stringbody: name* string, description string, spec object | orbit org templates patch <id>org_templates_patch |
DELETE /org/templates/{id}Delete a role template (what it gave stays) | write | id string | orbit org templates delete <id>org_templates_delete |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /org/jobsAssignment jobs, newest first | read | ?state queued | running | failed | done | cancelled?email string | orbit org jobs listorg_jobs_list |
GET /org/jobs/{id}One job and its steps | read | id string | orbit org jobs get <id>org_jobs_get |
POST /org/jobs/{id}/retryRun a failed job again from its failed step | write | id string | orbit org jobs retry <id>org_jobs_retry |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /org/policyOrganisation policies | read | — | orbit org policy getorg_policy_get |
PUT /org/policySet organisation policies; they are pushed to every member's account | write | body: require_mfa boolean, session_max_hours integer, meet_hosts_only boolean | orbit org policy putorg_policy_put |
| Endpoint | Scope | Parameters | CLI · MCP tool |
|---|---|---|---|
GET /org/auditThe organisation's audit log | read | ?limit integer?before integer | orbit org audit listorg_audit_list |
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.
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.
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.