Docs

Get Communication

GET /communications/{id}

GET/communications/{id}

Returns one communication in full: participants, bodies, tags, triage candidates and attachment details. The caller must own the mailbox it came from, or hold an event token for an event it is routed to and the event communications read permission. The id comes from Communications_GetEventCommunications or Communications_GetMine.

Path Parameters

FieldTypeRequiredDescription
iduuidRequired

Response

FieldTypeDescription
iduuid
orgIduuid
sourcestring| null
statusstring| null
fromParticipantResponse
toLineParticipantResponse[]| null
ccLineParticipantResponse[]| null
sentAtdate-time
subjectstring| null
textBodystring| null
htmlBodystring| null
isReadboolean
associationsAssociationResponse[]| null
candidatesCandidateResponse[]| null
attachmentsAttachmentResponse[]| null

ParticipantResponse

FieldTypeDescription
namestring| null
emailstring| null

AssociationResponse

FieldTypeDescription
iduuid
targetTypestring| null
targetIduuid
eventIduuid| null

CandidateResponse

FieldTypeDescription
iduuid
targetTypestring| null
targetIduuid
eventIduuid
reasonstring| null

AttachmentResponse

FieldTypeDescription
iduuid
fileNamestring| null
contentTypestring| null
sizeBytesinteger
isInlineboolean
statusstring| null
keptFileIduuid| null