Skip to content
Convor
Convor Docs
API ReferenceConversations

List conversations

Returns paginated conversations for the current organization.

GET/api/conversations

Returns paginated conversations for the current organization. Use the query to filter by status, priority, assignment, channel, visitor, or tags. The route also accepts one metadata.<path>=value filter for JSON metadata lookups, and visitor callers are automatically scoped to their own conversations. Operator callers only receive conversations after the visitor has sent at least one non-deleted message. Results are sorted with pinned conversations first and then by latest message activity. Message-less conversations use their creation time. Pagination defaults are applied by the query schema; use the returned pagination object instead of inferring more pages from the item count.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
conversations:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

status?string

Return only conversations in this state.

Value in

  • "active"
  • "open"
  • "closed"
  • "pending"
  • "snoozed"
  • "archived"
priority?string

Return only conversations with this priority.

Value in

  • "urgent"
  • "high"
  • "normal"
  • "low"
assigned?string

Filter by whether an operator is assigned.

Value in

  • "true"
  • "false"
assignedOperatorId?|

Filter by assigned operator, or null for unassigned items.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
allegroConnectionId?string

Return conversations received by this Allegro seller account.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
emailMailboxScope?string

Return only shared or private Email mailbox conversations.

Value in

  • "shared"
  • "private"
channel?string

Return only conversations from this channel.

Lengthlength <= 100
tags?string

Comma-separated tags that must match the conversation.

Lengthlength <= 500
tag?string

Single tag that must match the conversation.

Lengthlength <= 100
visitorId?string

Return only conversations for this visitor.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
awaitingOperatorReply?string

Filter by whether an operator reply is pending.

Value in

  • "true"
  • "false"
limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
Default20
page?integer

One-based page number.

Range1 <= value <= 9007199254740991
offset?integer

Zero-based number of resources to skip.

Range0 <= value <= 9007199254740991
Default0
scope?"all"

DA-4035: alternative to X-Project-Id: all for the all-sites aggregate scope on read-only aggregate routes. Only all is accepted; any other value returns PROJECT_SCOPE_NOT_SUPPORTED (400).

Value in

  • "all"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "data": [    {      "id": "11111111-1111-4111-8111-111111111111",      "organizationId": "22222222-2222-4222-8222-222222222222",      "projectId": "11111111-1111-4111-8111-111111111111",      "projectName": "Example name",      "visitorId": "33333333-3333-4333-8333-333333333333",      "operatorId": "44444444-4444-4444-8444-444444444444",      "status": "open",      "priority": "normal",      "source": "api",      "aiEnabled": true,      "locale": "en",      "localeSource": "organization_default",      "localeLocked": false,      "localeUpdatedAt": null,      "title": "Billing question",      "messageCount": 2,      "hasUnreadMessages": true,      "tags": [        "billing"      ],      "customFields": {},      "languageConfidence": 1,      "languageSource": "manual",      "translationActive": true,      "translationTargetLanguage": "example",      "createdAt": "2026-08-03T08:30:00.000Z",      "updatedAt": "2026-08-03T08:35:00.000Z"    }  ],  "pagination": {    "totalItems": 1,    "page": 1,    "pageSize": 20,    "hasNextPage": false,    "hasPrevPage": false  }}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/conversations' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/conversations", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Link this conversation to another (soft cross-reference)

Adds another conversation ID to metadata.linkedConversationIds for the source conversation.

List the canonical conversation timeline

Returns messages, visitor page views, internal notes, tag changes, transfers, CSAT responses, and audit entries in one deterministic newest-first cursor-paginated stream.

On this page

Request examplescurlJavaScript