Orbit Help API 参考

Orbit Help API。

共 8 个端点,其中 5 个只读。每一个都同时是 orbit 命令行中的命令、SDK 中的方法和 MCP 服务器上的工具。

01

tickets

端点权限参数CLI · MCP 工具
GET /helpdesk/tickets
List tickets, most recently updated first		只读?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		读写?org string
请求体: 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		只读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		读写number string
?org string
请求体: 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		读写number string
?org string
请求体: body* string, from agent | customer, internal boolean, agent_email string, author_name string, status string		orbit helpdesk tickets reply <number>
helpdesk_tickets_reply
02

customers

端点权限参数CLI · MCP 工具
GET /helpdesk/customers
Find a customer by email, or list customers, newest first		只读?email string
?limit integer
?offset integer
?org string		orbit helpdesk customers list
helpdesk_customers_list
03

departments

端点权限参数CLI · MCP 工具
GET /helpdesk/departments
Departments (queues) of the help desk		只读?org stringorbit helpdesk departments list
helpdesk_departments_list
04

statuses

端点权限参数CLI · MCP 工具
GET /helpdesk/statuses
Ticket statuses of the help desk		只读?org stringorbit helpdesk statuses list
helpdesk_statuses_list
继续

相关文档

账户 API 参考

Orbit API 中 账户 的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

组织 API 参考

Orbit API 中 组织 的全部 33 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

服务 API 参考

Orbit API 中 服务 的全部 15 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

← 全部文档