Partners API reference

Partners API.

9 endpoints, 5 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.

General

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /partner` The partner this credential belongs to, and who it is acting for	read	—	`orbit partners me` `partners_me`
`GET /partner/audit` Recent actions taken under this partner	read	—	`orbit partners audit` `partners_audit`

subjects

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /partner/subjects` Customers this partner may act for	read	—	`orbit partners subjects list` `partners_subjects_list`
`POST /partner/subjects` Create a managed customer (managed mode only)	write	body: `external_ref`* string	`orbit partners subjects create` `partners_subjects_create`
`GET /partner/subjects/{ref}` One customer with the ranges they hold	read	`ref` string	`orbit partners subjects get <ref>` `partners_subjects_get`
`DELETE /partner/subjects/{ref}` Stop acting for a managed customer	write	`ref` string	`orbit partners subjects delete <ref>` `partners_subjects_delete`
`POST /partner/subjects/{ref}/token` Mint a short-lived credential that acts for one customer	write	`ref` string body: `scope` read \| write	`orbit partners subjects token <ref>` `partners_subjects_token`
`POST /partner/subjects/{ref}/embed` One-time link to the embedded panel for one customer	write	`ref` string	`orbit partners subjects embed <ref>` `partners_subjects_embed`

oauth

Endpoint	Scope	Parameters	CLI · MCP tool
`POST /partner/oauth/token` Exchange an authorisation code for a customer credential (PKCE S256)	read	body: `client_id`* string, `code`* string, `code_verifier`* string, `redirect_uri`* string	`orbit partners oauth token` `partners_oauth_token`

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.

Organization API reference

Every Organization 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.

← All documentation