Skip to main content
GET
Read a ticket sent to an agency

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agency
string
required

The agency key, as a root admin created it.

Maximum string length: 64
Pattern: ^[a-z0-9_]+$
id
string<uuid>
required

The ticket UUID returned in an agency queue page.

Response

The ticket with its company.

task
object
required

A ticket as an agency's member reads it: the task API's ticket plus the company it belongs to, who in the agency has picked it up, and the agency's sent request for it. The customer's linked threads and Mist's plan stay with the company: source_threads is always empty, and run_thread_id and plan are always null. A pick-up or release sends the request's version back as expected_version, so a change made since is refused.

editable
boolean
required

Whether the member may change the status now; false while the ticket is handed.

status
any
required
meta
object
required
attachments
object[]

The images and files the customer attached, oldest first, each with a link that reads it for one minute. Present only while the cowork-ticket-attachments release is on for the ticket's company.