CHcheckhq

Get a communication

get/communications/{communication}

Request

Path parameters

communicationstring required

ID of the communication to return

Response

200

idstring
companystring
recipient_typestring
recipientstring
typestring
originatorstring
created_atstring

Example response

{
  "id": "cmn_MrFrw0F82NSJjyw10Erk",
  "company": "com_zH8Gq33iBkFj5o0GKjTw",
  "recipient_type": "company_email",
  "recipient": "com_zH8Gq33iBkFj5o0GKjTw",
  "type": "email",
  "originator": "check",
  "email": {
    "to": [
      "example@gmail.com"
    ],
    "from": "support@checkhq.zendesk.com",
    "cc": [
      "payroll-support@partner.co"
    ],
    "subject": "Check <> Example Coffee"
  },
  "created_at": "2024-01-19 17:04:15+00"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.