List messages for a conversation
Returns messages for one conversation using cursor-based pagination.
/api/conversations/{id}/messagesReturns messages for one conversation using cursor-based pagination. Results are sorted newest first, and you can pass the previous nextCursor value as cursor to fetch older messages. Visitor callers can read only their own conversations, and internal notes are hidden from visitors. The default limit is 50 and the maximum limit is 100.
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
Opaque cursor returned by the previous page.
Maximum number of resources 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": "7f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "conversationId": "9f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "content": "Hello, how can I help you today?", "senderType": "operator", "senderId": "6f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "type": "text", "createdAt": "2026-06-23T08: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/messages' \
--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/messages", {
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?