Read a conversation

Error

A valid request URL is required to generate request examples

{
  "environment": "live",
  "conversation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "channel": "email",
    "subject": "<string>",
    "status": "open",
    "priority": "low",
    "assignee_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "snoozed_until": "2023-11-07T05:31:56Z",
    "first_responded_at": "2023-11-07T05:31:56Z",
    "resolved_at": "2023-11-07T05:31:56Z",
    "last_message_at": "2023-11-07T05:31:56Z",
    "last_contact_message_at": "2023-11-07T05:31:56Z",
    "first_response_due_at": "2023-11-07T05:31:56Z",
    "resolution_due_at": "2023-11-07T05:31:56Z",
    "sla_first_breached_at": "2023-11-07T05:31:56Z",
    "sla_resolution_breached_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "author_kind": "contact",
      "author_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "visibility": "public",
      "body_text": "<string>",
      "body_html": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "color": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

GET

support

conversations

{id}

Error

A valid request URL is required to generate request examples

{
  "environment": "live",
  "conversation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "channel": "email",
    "subject": "<string>",
    "status": "open",
    "priority": "low",
    "assignee_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "snoozed_until": "2023-11-07T05:31:56Z",
    "first_responded_at": "2023-11-07T05:31:56Z",
    "resolved_at": "2023-11-07T05:31:56Z",
    "last_message_at": "2023-11-07T05:31:56Z",
    "last_contact_message_at": "2023-11-07T05:31:56Z",
    "first_response_due_at": "2023-11-07T05:31:56Z",
    "resolution_due_at": "2023-11-07T05:31:56Z",
    "sla_first_breached_at": "2023-11-07T05:31:56Z",
    "sla_resolution_breached_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "author_kind": "contact",
      "author_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "visibility": "public",
      "body_text": "<string>",
      "body_html": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "color": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Authorizations

Authorization

string

header

required

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.

Headers

X-Organization-Id

string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.

Path Parameters

string<uuid>

required

Query Parameters

environment

enum<string>

default:live

Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.

Available options:

live,

test

Response

The conversation, its messages and its tags.

environment

enum<string>

Available options:

live,

test

conversation

object

One support thread, as staff see it. Ticket and chat are the same object — channel is the only thing that differs between an email thread and a widget chat.

Show child attributes

messages

object[]