Skip to content

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

Name
Type
Required
Description
id
string
•
Thread id

Response

Field
Type
Always
Description
id
string
•
Thread id
type
string
•
ticket: the end user wants something fixed. feedback: unsolicited input
title
string
•
Thread subject
labels
array
•
Every label on the thread, by name
rating
integer
•
The score the client supplied at creation, or null while the thread is unrated
status
object
•
The status itself, joined in at read time
labelIds
array
•
The same labels as a flat list of ids, in the order labels[] has them. This is the value support_thread_update takes back: a dot-path can name this whole set, while labels.0.id names only the first element
metadata
object
•
Free-form client-owned JSON
priority
string
•
Thread priority
statusId
string
•
Id of the status the thread sits on
createdAt
string
•
ISO-8601 creation timestamp
updatedAt
string
•
ISO-8601 last-modification timestamp
labelNames
array
•
The same labels as a flat list of names, in the order labels[] has them
lastReplyAt
string
•
ISO-8601 timestamp of the last reply, or null while there are none
authorDisplay
string
•
Display name for the external author, if given
assignedAgentId
string
•
Assigned agent, or null while unassigned
authorExternalId
string
•
The 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.

↑↓navigate↵select