v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

List communications

get/communications

Query parameters

companystring

Return communications for all entities associated with this company.

start_datestring date

Return communications created on or after the provided date (format: YYYY-MM-DD)

end_datestring date

Return communications created on or before the provided date (format: YYYY-MM-DD)

typestring

Return communications for this communication type (email or text)

recipientstring

Return communications for this recipient.

recipient_typestring

Return communications for this recipient type (company_email, employee_email, contractor_email)

Response

200

{"stackTrail":"paths:/communications:get:responses:200:content:application/json:schema:properties:next","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/communications:get:responses:200:content:application/json:schema:properties:previous","oasType":"schema","type":"unknown"}

Example response

{
  "results": [
    {
      "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"
    }
  ]
}