Retrieve a conversation

GET/conversations/{id}

Returns one conversation with every message part, internal notes, participants, tags and SLA state in a single call. Message bodies are always included.

Required scope: conversations:read. Notes also need notes:read.

Path parameters

Path parameters
idstring, requiredThe conversation ID, for example cnv_7Hq2Lm.

Query parameters

Query parameters
expand[]array of stringsRelated objects to return in full: contact, assignee, company. Saves extra calls.
include_notesbooleanInclude internal notes. Default false.
parts_limitintegerMessage parts per page. Default 50, maximum 200.
parts_cursorstringThe next_cursor from the previous page of parts.

Errors

Errors
401 unauthorizedThe key is missing, expired or revoked.
403 forbiddenThe key is valid but lacks the conversations:read scope.
404 not_foundNo conversation with this ID in this workspace.
421 wrong_regionThe key belongs to another region. The error names the correct base URL.