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.
/api/conversations/{id}/timelineReturns messages, visitor page views, internal notes, tag changes, transfers, CSAT responses, and audit entries in one deterministic newest-first cursor-paginated stream. Message events contain the same hydrated message payload used by the conversation message API, including attachments, translations, quoted messages, reactions metadata, delivery state, and edit state.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-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.
Path Parameters
Resource identifier.
^([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)$uuidQuery Parameters
Query parameter. Opaque cursor used to request the next page of results.
1 <= length <= 1024Query parameter. Maximum number of records to return.
1 <= value <= 10050Header Parameters
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": "22222222-2222-4222-8222-222222222222", "type": "page_view", "occurredAt": "2026-06-23T09:01:00.000Z", "pageUrl": "https://convor.io/pricing", "pageTitle": "Pricing" }, { "id": "33333333-3333-4333-8333-333333333333", "type": "message", "occurredAt": "2026-06-23T09:00:00.000Z", "message": { "id": "33333333-3333-4333-8333-333333333333", "conversationId": "11111111-1111-4111-8111-111111111111", "content": "I need help with billing.", "senderType": "visitor", "senderId": "44444444-4444-4444-8444-444444444444", "type": "text", "createdAt": "2026-06-23T09:00:00.000Z", "isRead": false, "isEdited": false, "editedAt": null, "replyToId": null, "metadata": {} } } ], "nextCursor": null, "hasMore": false}Request examples
curl
curl --request GET \
'https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/timeline' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/timeline", {
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?