v1

latestOpenAPI 3.0.02026-07-26870415.2 KB

helpdesk_tickets

List helpdesk tickets

Returns cursor-paginated helpdesk tickets mirrored from the workspace's helpdesk integrations (Zendesk, Pylon, Plain). Filter by status, channel, or connection_id.

get/v1/helpdesk-tickets

Query parameters

workspace_idstring required

Workspace to query.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o

limitinteger

Page size. Defaults to 20. Max 100.

cursorstring

Pagination cursor returned as next_cursor on the previous page.

order'asc' | 'desc'

Sort direction over last external update time. Defaults to desc.

statusstring

Filter by helpdesk status. Values depend on the upstream helpdesk system (examples: open, new, pending, solved, closed).

Example:open

channelstring

Filter by the channel the ticket arrived on (examples: email, web, chat).

connection_idstring

Filter to tickets from a single helpdesk connection (Zendesk/Pylon/Plain instance).

Response

Helpdesk tickets

next_cursorstring nullable required

has_moreboolean required

Example response

{
  "data": [
    {
      "id": "hd77c0dy0mgdpzmqz6tesry8w184002s",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "contact_id": "ph77c0dy0mgdpzmqz6tesry8w184002s",
      "ticket_id": "tk77c0dy0mgdpzmqz6tesry8w184002s",
      "connection_id": "cn77c0dy0mgdpzmqz6tesry8w184002s",
      "external_ticket_id": "zd_12345",
      "external_group_id": "grp_42",
      "external_assignee_id": "usr_987",
      "subject": "Unable to access door code",
      "description": "Guest reports the keypad is not accepting the code.",
      "status": "open",
      "priority": "high",
      "type": "incident",
      "channel": "email",
      "tags": [
        "urgent",
        "access"
      ],
      "requester": {
        "external_id": "zd_user_abc",
        "name": "Taylor Reid",
        "email": "taylor.reid@example.com"
      },
      "last_external_update_at": "2026-04-19T14:05:00.000Z",
      "created_at": "2026-04-19T13:48:00.000Z"
    }
  ],
  "next_cursor": "page-token",
  "has_more": true
}