Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/conversations/{id}` — one thread with a page of its messages.

GET
/api/conversations/{id}
curl --request GET \
  --url https://example.com/api/conversations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie supacloud_session=<supacloud_session>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Conversation id

Query Parameters

Section titled “Query Parameters”
limit
integer format: int64

Messages per page (default 50, max 200)

offset
integer format: int64

Message offset

Responses

Section titled “Responses”

200

Section titled “200”

The thread.

Media typeapplication/json

GET /api/conversations/{id} body — the head plus a page of its thread.

object
conversation
required

One row of the conversations board.

object
assigned_to
string | null format: uuid
assignment_origin
required

provider | local — WHICH SYSTEM owns the assignment. The UI must not offer a local reassign control on a provider row; that assignment lives in Chatwoot/Intercom and a local write would be silently overwritten on the next delivery.

string
channel
required
string
contact_id
string | null format: uuid
created_at
required
string format: date-time
external_id
required
string
id
required
string format: uuid
last_message_at
string | null format: date-time
status
required
string
subject
string | null
messages
required
Array<object>

One message in a thread.

object
author_kind
required

contact | agent | bot | system. agent is a human replying in the provider’s own UI; bot is one of our own agent replies.

string
author_name
string | null
body
required
string
direction
required

inbound (from the contact) | outbound (from an agent).

string
id
required
string format: uuid
occurred_at
required
string format: date-time
private
required

An internal note rather than a customer-visible message.

boolean
sequence_num
required

Gapless position in the thread — the ordering key. Deliberately exposed: the FE detects a gap (a dropped page) by sequence, not by timestamp, because provider clocks are not monotonic.

integer format: int32
total_messages
required

Total messages in the thread (the paging companion to messages).

integer format: int64
Examplegenerated
{
  "conversation": {
    "assigned_to": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "assignment_origin": "example",
    "channel": "example",
    "contact_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "created_at": "2026-04-15T12:00:00Z",
    "external_id": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "last_message_at": "2026-04-15T12:00:00Z",
    "status": "example",
    "subject": "example"
  },
  "messages": [
    {
      "author_kind": "example",
      "author_name": "example",
      "body": "example",
      "direction": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "occurred_at": "2026-04-15T12:00:00Z",
      "private": true,
      "sequence_num": 1
    }
  ],
  "total_messages": 1
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

404

Section titled “404”

No such conversation in this workspace

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}