Open HelpDesk API
Run in Postman
  • Getting started
  • Assistants
  • API reference
Information
Tickets
    List ticketsgetCreate a ticketpostRead a ticketgetUpdate a ticketpatchList a ticket's messagesgetAdd a reply or an internal notepostList every file on a ticketget
Contacts
    List contactsgetCreate a contactpostRead a contactgetDelete a contact (GDPR erasure)deleteUpdate a contactpatch
Organizations
    List organizationsgetCreate an organizationpostRead an organizationgetDelete an organizationdeleteUpdate an organizationpatch
Knowledge base
    List categoriesgetList articlesgetCreate an articlepostRead an articlegetDelete an articledeleteUpdate an articlepatch
Attachments
    Download a fileget
Workspace
    List agentsgetList teamsgetList macrosgetList SLA policiesgetList saved viewsgetList custom ticket fieldsgetList tags in usegetList satisfaction responsesget
Mobile
    Mark a ticket readpostSign in on a devicepostStart an SSO sign-in from the appgetFinish an SSO sign-inpostSign this device outpostThe agent this device is signed in asgetTake work, or stop taking workpatchRegister for push notificationspostStop notifying this devicedeleteWhat happened on my tickets while I was awaygetMark everything readpostSearch tickets, contacts, organizations and articlesget
Customer app
    Email a customer their sign-in linkpostHand an emailed sign-in over to the appgetFinish a customer sign-inpostSign this device outpostThe customer this device is signed in asgetThe requests a customer may seegetSubmit a requestpostRead a request and its conversationgetAnswer on your own requestpostRegister for push notificationspostStop notifying this devicedeleteNews about my requestsgetMark everything readpost
Schemas
powered by Zudoku
Open HelpDesk API
Open HelpDesk API

Workspace

Agents, teams and the configuration rules run on.


List agents

GET
https://{workspace}.open-helpdesk.com/api/v1
/agents

List agents › query Parameters

limit
​integer · min: 1 · max: 100

Rows per page.

Default: 25
cursor
​string

The next_cursor of the previous page.

List agents › Responses

List agents

​Agent[] · required
next_cursor
​string · required

Pass back as cursor for the next page. Null on the last page.

GET/agents
curl 'https://{workspace}.open-helpdesk.com/api/v1/agents' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "email": "test@example.com", "name": "name", "role": "owner", "status": "active", "available": true, "created_at": "2024-08-25T15:00:00Z" } ], "next_cursor": "next_cursor" }
json
application/json

List teams

GET
https://{workspace}.open-helpdesk.com/api/v1
/teams

List teams › query Parameters

limit
​integer · min: 1 · max: 100

Rows per page.

Default: 25
cursor
​string

The next_cursor of the previous page.

List teams › Responses

List teams

​Team[] · required
next_cursor
​string · required

Pass back as cursor for the next page. Null on the last page.

GET/teams
curl 'https://{workspace}.open-helpdesk.com/api/v1/teams' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "name": "name", "created_at": "2024-08-25T15:00:00Z" } ], "next_cursor": "next_cursor" }
json
application/json

List macros

GET
https://{workspace}.open-helpdesk.com/api/v1
/macros

List macros › query Parameters

limit
​integer · min: 1 · max: 100

Rows per page.

Default: 25
cursor
​string

The next_cursor of the previous page.

List macros › Responses

List macros

​Macro[] · required
next_cursor
​string · required

Pass back as cursor for the next page. Null on the last page.

GET/macros
curl 'https://{workspace}.open-helpdesk.com/api/v1/macros' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "name": "name", "category": "category", "actions": {}, "availability": "everyone", "team_id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "created_at": "2024-08-25T15:00:00Z" } ], "next_cursor": "next_cursor" }
json
application/json

List SLA policies

GET
https://{workspace}.open-helpdesk.com/api/v1
/sla-policies

List SLA policies › query Parameters

limit
​integer · min: 1 · max: 100

Rows per page.

Default: 25
cursor
​string

The next_cursor of the previous page.

List SLA policies › Responses

List SLA policies

​SlaPolicy[] · required
next_cursor
​string · required

Pass back as cursor for the next page. Null on the last page.

GET/sla-policies
curl 'https://{workspace}.open-helpdesk.com/api/v1/sla-policies' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "name": "name", "position": 0, "conditions": {}, "targets": {}, "business_hours_id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "is_default": true, "active": true } ], "next_cursor": "next_cursor" }
json
application/json

List saved views

GET
https://{workspace}.open-helpdesk.com/api/v1
/views

List saved views › query Parameters

limit
​integer · min: 1 · max: 100

Rows per page.

Default: 25
cursor
​string

The next_cursor of the previous page.

List saved views › Responses

List saved views

​View[] · required
next_cursor
​string · required

Pass back as cursor for the next page. Null on the last page.

GET/views
curl 'https://{workspace}.open-helpdesk.com/api/v1/views' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "name": "name", "shared": "private", "team_id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "conditions": {}, "columns": {}, "sort": {}, "position": 0, "count": 12 } ], "next_cursor": "next_cursor" }
json
application/json

List custom ticket fields

GET
https://{workspace}.open-helpdesk.com/api/v1
/ticket-fields

List custom ticket fields › query Parameters

limit
​integer · min: 1 · max: 100

Rows per page.

Default: 25
cursor
​string

The next_cursor of the previous page.

List custom ticket fields › Responses

List custom ticket fields

​TicketField[] · required
next_cursor
​string · required

Pass back as cursor for the next page. Null on the last page.

GET/ticket-fields
curl 'https://{workspace}.open-helpdesk.com/api/v1/ticket-fields' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "key": "key", "label": "label", "type": "text", "options": {}, "portal_visible": true, "required": true, "position": 0 } ], "next_cursor": "next_cursor" }
json
application/json

List tags in use

GET
https://{workspace}.open-helpdesk.com/api/v1
/tags

Derived from the tickets themselves — the product keeps no separate tag registry.

List tags in use › Responses

Tags with how many tickets carry each.

​Tag[] · required
next_cursor
​string · required

Pass back as cursor for the next page. Null on the last page.

GET/tags
curl 'https://{workspace}.open-helpdesk.com/api/v1/tags' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "name": "billing", "ticket_count": 128 } ], "next_cursor": "next_cursor" }
json
application/json

List satisfaction responses

GET
https://{workspace}.open-helpdesk.com/api/v1
/csat

List satisfaction responses › query Parameters

limit
​integer · min: 1 · max: 100

Rows per page.

Default: 25
cursor
​string

The next_cursor of the previous page.

List satisfaction responses › Responses

List satisfaction responses

​Csat[] · required
next_cursor
​string · required

Pass back as cursor for the next page. Null on the last page.

GET/csat
curl 'https://{workspace}.open-helpdesk.com/api/v1/csat' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "ticket_id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "agent_id": "3f2a1c94-8e5b-4d17-9f60-2c7b1a0d5e83", "score": "good", "comment": "comment", "created_at": "2024-08-25T15:00:00Z" } ], "next_cursor": "next_cursor" }
json
application/json

AttachmentsMobile