Get ticket and thread

GET

/v1/support/tickets/{ticketId}

curl --request GET \
  --url https://shareout.site/v1/support/tickets/example \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

ticketId

required

string

Responses

200

Ticket with messages

Media typeapplication/json

object

success

boolean

ticket

object

id

string

subject

string

status

string

Allowed values: open pending resolved closed

channel

string

Allowed values: ui skill email telegram slack

workspace_id

string

nullable

requester_user_id

string

nullable

requester_email

string format: email

nullable

priority

string

nullable

created_at

string format: date-time

updated_at

string format: date-time

thread

Array<object>

object

id

string

role

string

Allowed values: customer staff system

body

string

created_at

string format: date-time

Example

{
  "ticket": {
    "status": "open",
    "channel": "ui"
  },
  "thread": [
    {
      "role": "customer"
    }
  ]
}

403

Access denied

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

404

Resource not found

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}