Get conversation by ID
Returns one conversation from the current organization, including the joined visitor record and computed dashboard fields such as unreadCount, tags, messageCount, and firstResponseTimeMs.
/api/conversations/{id}Returns one conversation from the current organization, including the joined visitor record and computed dashboard fields such as unreadCount, tags, messageCount, and firstResponseTimeMs. Visitor callers can read only their own conversations. Missing conversations, cross-organization access, or history outside the caller's allowed window return an error.
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)$uuidHeader 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
{ "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": null, "status": "open", "priority": "normal", "source": "widget", "aiEnabled": true, "locale": "en", "localeSource": "organization_default", "localeLocked": false, "localeUpdatedAt": null, "snoozedUntil": null, "lastMessageAt": "2026-06-23T08:30:00.000Z", "title": "Need help with billing", "messageCount": 4, "hasUnreadMessages": true, "tags": [ "billing" ], "customFields": {}, "language": null, "languageConfidence": 1, "languageSource": "manual", "translationActive": true, "translationTargetLanguage": "example", "aiSummary": null, "aiSummaryGeneratedAt": null, "aiClassification": null, "metadata": {}, "version": 1, "createdAt": "2026-06-23T08:00:00.000Z", "updatedAt": "2026-06-23T08:30:00.000Z", "visitor": { "id": "33333333-3333-4333-8333-333333333333", "identifier": "[email protected]", "publicCode": "VIS-3A3B", "identitySource": "verified", "identityVerifiedAt": "2026-06-23T08:05:00.000Z", "fingerprint": null, "geoCountry": null, "geoCity": null, "totalSessions": 1, "firstSeenAt": "2026-06-23T08:00:00.000Z", "lastSeenAt": "2026-06-23T08:30:00.000Z", "name": "Avery Visitor", "email": "[email protected]", "phone": null, "metadata": {} }, "lastMessage": null, "unreadCount": 0}Request examples
curl
curl --request GET \
'https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111' \
--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", {
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?