Skip to content

Support

support_thread_get

Get one support thread by id, with its status joined in.

Tool

support_thread_get

Get one support thread by id, with its status joined in.

Get one support thread by id, with its status joined in. A thread belonging to another product is reported as not found

Behavior

HTTP
GET /support/threads/:id

Arguments

NameTypeRequiredDescription
idstringThread id

Response

FieldTypeAlwaysDescription
idstringThread id
typestringticket: the end user wants something fixed. feedback: unsolicited input
titlestringThread subject
labelsarrayEvery label on the thread, by name
ratingintegerThe score the client supplied at creation, or null while the thread is unrated
statusobjectThe status itself, joined in at read time
metadataobjectFree-form client-owned JSON
prioritystringThread priority
statusIdstringId of the status the thread sits on
createdAtstringISO-8601 creation timestamp
updatedAtstringISO-8601 last-modification timestamp
lastReplyAtstringISO-8601 timestamp of the last reply, or null while there are none
authorDisplaystringDisplay name for the external author, if given
assignedAgentIdstringAssigned agent, or null while unassigned
authorExternalIdstringThe external author, byte-identical to what was stored

Try it

Get one support thread by id, with its status joined in.

When to use

Get one support thread by id, with its status joined in. A thread belonging to another product is reported as not found

Example

Ask your agent something like this:

Get one support thread by id, with its status joined in.

The agent will invoke support_thread_get with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect