Organization API reference

Organization API.

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.

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 | member | guest, template_ids string[]orbit 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 | 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)
writesub stringorbit org members remove <sub>
org_members_remove
GET /org/members/{sub}/bindings
A member's (role, scope) bindings
readsub stringorbit org members bindings list <sub>
org_members_bindings_list
POST /org/members/{sub}/bindings
Give a member a role on the organisation or on a group; joining a group gives what it carries
writesub string
body: role* string, scope_id string
orbit org members bindings add <sub>
org_members_bindings_add
POST /org/members/{sub}/bindings/remove
Remove a binding; what that group gave is taken back
writesub string
body: role* string, scope_id string
orbit org members bindings remove <sub>
org_members_bindings_remove
GET /org/members/{sub}/assignments
What a member has been given in each product
readsub string
?all 1
orbit org members assignments list <sub>
org_members_assignments_list
POST /org/members/{sub}/assignments
Give a member one item (a mailbox, an extension, a shared drive, …); runs as a job
writesub string
body: 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}/templates
Apply role templates to a member (preview: true to see the plan first)
writesub string
body: template_ids* string[], preview boolean
orbit org members templates <sub>
org_members_templates
POST /org/members/{sub}/offboard
Remove a member: every assignment goes where its mode says; restorable for 30 days (preview: true lists the items and modes)
writesub string
body: preview boolean, modes object
orbit org members offboard <sub>
org_members_offboard
POST /org/members/{sub}/restore
Restore a member removed less than 30 days ago, with everything they had
writesub stringorbit org members restore <sub>
org_members_restore
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
06

orgs

EndpointScopeParametersCLI · MCP tool
GET /orgs
Every organisation this account belongs to
read—orbit org orgs list
org_orgs_list
07

groups

EndpointScopeParametersCLI · MCP tool
GET /org/groups
Groups and departments (a tree of at most three levels)
read—orbit org groups list
org_groups_list
POST /org/groups
Create a group, or a department inside one
writebody: name* string, parent_id string, description stringorbit org groups create
org_groups_create
PATCH /org/groups/{id}
Rename a group or change what it gives its members
writeid string
body: name string, description string, links object
orbit org groups patch <id>
org_groups_patch
DELETE /org/groups/{id}
Delete an empty group
writeid stringorbit org groups delete <id>
org_groups_delete
08

templates

EndpointScopeParametersCLI · MCP tool
GET /org/templates
Role templates
read—orbit org templates list
org_templates_list
POST /org/templates
Create a role template
writebody: name* string, description string, spec objectorbit org templates create
org_templates_create
PATCH /org/templates/{id}
Replace a role template's name and items
writeid string
body: 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)
writeid stringorbit org templates delete <id>
org_templates_delete
09

jobs

EndpointScopeParametersCLI · MCP tool
GET /org/jobs
Assignment jobs, newest first
read?state queued | running | failed | done | cancelled
?email string
orbit org jobs list
org_jobs_list
GET /org/jobs/{id}
One job and its steps
readid stringorbit org jobs get <id>
org_jobs_get
POST /org/jobs/{id}/retry
Run a failed job again from its failed step
writeid stringorbit org jobs retry <id>
org_jobs_retry
10

policy

EndpointScopeParametersCLI · MCP tool
GET /org/policy
Organisation policies
read—orbit org policy get
org_policy_get
PUT /org/policy
Set organisation policies; they are pushed to every member's account
writebody: require_mfa boolean, session_max_hours integer, meet_hosts_only booleanorbit org policy put
org_policy_put
11

audit

EndpointScopeParametersCLI · MCP tool
GET /org/audit
The organisation's audit log
read?limit integer
?before integer
orbit org audit list
org_audit_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