Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/conversations` — one server-paginated, filtered page of the board.

GET
/api/conversations
curl --request GET \
  --url https://example.com/api/conversations \
  --cookie supacloud_session=<supacloud_session>

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
string

Free-text over the subject AND the message bodies (full-text), so a thread is findable by something said inside it, not only by its title.

status
string

Status chip. Matched as an opaque string — the column carries no CHECK because a provider may define its own status.

channel
string

Channel chip (chatwoot | intercom | …).

assigned_to
string format: uuid

Restrict to one assignee (“mine”).

unassigned
boolean

Only threads nobody has picked up.

sort
string

Whitelisted sort column: last_message_at | created_at | subject.

dir
string

asc | desc (default desc).

limit
integer format: int64
offset
integer format: int64
include_facets
boolean

Recompute the facet chips (default true); the board sends false on a page/sort change because the chip counts are workspace-wide.

Responses

Section titled “Responses”

200

Section titled “200”

One page of conversations.

Media typeapplication/json

GET /api/conversations body — the {items, total, facets} board standard.

object
facets
One of:
null
items
required
Array<object>

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
total
required
integer format: int64
Examplegenerated
{
  "facets": {
    "channels": {
      "additionalProperty": 1
    },
    "statuses": {
      "additionalProperty": 1
    },
    "unassigned": 1
  },
  "items": [
    {
      "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"
    }
  ],
  "total": 1
}

400

Section titled “400”

Structured client 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"
}

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"
}

403

Section titled “403”

Permission denied

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"
}