Docs

GET /support/{ref}

One support request and its public thread.

Parameters

  • ref path · string · required

Responses

  • 200 Success
  • 400 Validation error
  • 401 Missing API key
  • 403 Forbidden
  • 404 Not found
  • 409 Conflict
  • 429 Rate limited
  • 500 Internal server error

Response headers

  • ratelimit-limit — Messages this API key may spend in one 60-second window.
  • ratelimit-remaining — Messages left in the current window.
  • ratelimit-reset — Seconds until the current window resets and the budget refills.

200 body

FieldTypeRequiredNotes
can_reopenbooleanyes
closed_atstring | nullyes
created_atstringyes
csat_scoreinteger | nullyes
has_unread_replybooleanyes
idstringyes
last_message_atstringyes
last_message_previewstringyes
message_countintegeryes
messagesarray<object>yes
messages[].attachmentsarray<object>yes
messages[].author_namestringyes
messages[].author_type"customer" | "operator" | "system"yes
messages[].body_htmlstring | nullyes
messages[].body_textstringyes
messages[].channel"form" | "email" | "mcp" | "admin"yes
messages[].created_atstringyes
messages[].idstringyes
messages[].ticket_idstringyes
messages[].visibility"public" | "internal" | "system"yes
refintegeryes
ref_labelstringyes
related_idstring | nullyes
related_typestring | nullyes
resolved_atstring | nullyes
status"open" | "waiting_on_us" | "waiting_on_customer" | "resolved" | "closed"yes
status_labelstringyes
subjectstringyes
topic"sending" | "domains" | "deliverability" | "guardrails_and_limits" | "trust_and_appeals" | "webhooks" | …yes
updated_atstringyes

Errors

Codes in the catalogue that answer with one of this operation’s error statuses. Every one of them carries a fix.