Docs
Tickets

Get a ticket

Returns one ticket by its UUID, with its thread.

GET/api/v1/tickets/{id}

Internal notes are never included — they are the team talking to itself. Responds 404 rather than 403 for a ticket in another workspace, so ids cannot be enumerated.

Path parameters

Prop

Type

Response 200

Prop

Type

Errors

  • 401 — Missing or invalid API key
  • 404 — Not found
  • 429 — Rate limit exceeded

Every error shares one envelope.

Example

curl https://www.hey.support/api/v1/tickets/<id> \
  -H 'Authorization: Bearer hs_live_…'

Open a ticket

Opens a ticket from outside the chat — a form on your own site, or an inbox you triage by hand.

Update a ticket

Moves a ticket on, or changes how it is filed.

On this page

Path parameters
Response 200
Errors
Example