Help API reference

Help API.

8 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.

tickets

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /helpdesk/tickets` List tickets, most recently updated first	read	`?status` string `?department_id` integer `?customer` string `?assignee` string `?updated_since` string `?limit` integer `?offset` integer `?org` string	`orbit helpdesk tickets list` `helpdesk_tickets_list`
`POST /helpdesk/tickets` Open a ticket for a customer	write	`?org` string body: `customer`* object, `subject`* string, `body`* string, `department_id` integer, `priority` low \| normal \| high \| urgent, `tags` string[], `notify_customer` boolean	`orbit helpdesk tickets create` `helpdesk_tickets_create`
`GET /helpdesk/tickets/{number}` A ticket with its messages and attachments	read	`number` string `?org` string	`orbit helpdesk tickets get <number>` `helpdesk_tickets_get`
`PATCH /helpdesk/tickets/{number}` Change a ticket's status, priority, department, assignee or tags	write	`number` string `?org` string body: `status` string, `priority` low \| normal \| high \| urgent, `department_id` integer, `assignee_email` string, `add_tags` string[], `remove_tags` string[]	`orbit helpdesk tickets update <number>` `helpdesk_tickets_update`
`POST /helpdesk/tickets/{number}/replies` Reply to a ticket, add an internal note, or add a message from the customer	write	`number` string `?org` string body: `body`* string, `from` agent \| customer, `internal` boolean, `agent_email` string, `author_name` string, `status` string	`orbit helpdesk tickets reply <number>` `helpdesk_tickets_reply`

customers

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /helpdesk/customers` Find a customer by email, or list customers, newest first	read	`?email` string `?limit` integer `?offset` integer `?org` string	`orbit helpdesk customers list` `helpdesk_customers_list`

departments

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /helpdesk/departments` Departments (queues) of the help desk	read	`?org` string	`orbit helpdesk departments list` `helpdesk_departments_list`

statuses

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /helpdesk/statuses` Ticket statuses of the help desk	read	`?org` string	`orbit helpdesk statuses list` `helpdesk_statuses_list`

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 (33): 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