---
title: "Get communication"
method: GET
path: "/communications/{id}"
tags: ["Communication"]
---

# Get communication

`GET /communications/{id}`

## Path parameters

- `id` string, int64, required

## Query parameters

- `q[]` string[]

## Response `200`

Successful operation

- union
  - object
    - `archived_at` string, date-time, nullable
    - `category` 'Memo', nullable
    - `category_code` 12, nullable — | Enum Value | Description | |---|---| |12|Memo|
    - `confidential` boolean, nullable
    - `content` string, nullable
    - `created_at` string, date-time
    - `direction_code` 1 | 2, nullable — | Enum Value | Description | |---|---| | 1 | Sent | | 2 | Received |
    - `direction_description` 'Received' | 'Sent', nullable
    - `from` string, nullable
    - `id` string, int64
    - `links` object
      - `self` string, uri
    - `patient` object
      - `links` object
        - `self` string, uri
    - `to` string, nullable
    - `type` 'Email' | 'Other' | 'Phone call' | 'SMS', nullable
    - `type_code` 1 | 2 | 3 | 4, nullable — | Enum Value | Description | |---|---| | 1 | SMS | | 2 | Email | | 3 | Phone call | | 4 | Other |
    - `updated_at` string, date-time
  - object
    - `archived_at` string, date-time, nullable
    - `attendee` object
      - `links` object
        - `self` string, uri
    - `booking` object
      - `links` object
        - `self` string, uri
    - `category` 'Account Statement' | 'Account ownership information updated' | 'Appointment Cancellation' | 'Appointment Confirmation' | 'Appointment Follow Up Message' | 'Appointment Reminder' | 'Auth Code' | 'Bulk Email' | 'Cancelled appointment notification' | 'Card automatically updated notification' | 'Card expiring notification' | 'Completed Patient Form' | 'Data export complete notification' | 'Email OTP code' | 'Invoice' | 'Letter' | 'Mailchimp integration disconnected' | 'Memo' | 'New user' | 'Online payment request' | 'Password changed' | 'Patient Form' | 'Patient Reply Forwarded' | 'Patient form renewal' | 'Payment Receipt' | 'Practitioner Appointment Notification' | 'Referred user bonus notification' | 'Referred user signed up' | 'Referring user bonus notification' | 'Reply from Patient' | 'Reply from Practitioner' | 'Rescheduled Appointment Notification' | 'Reset password instructions' | 'SMS Message' | 'SMS credit purchase failed' | 'SMS credit purchase receipt' | 'SMS credit purchase reminder' | 'SMS credit purchase requires confirmation' | 'Stripe receipt' | 'Subscription initiation alert' | 'Subscription payment failure' | 'Today's appointments for practitioner' | 'Treatment note' | 'Trial ending reminder' | 'Trial payment failure' | 'Unlock instructions' | 'Upcoming appointments' | 'Upcoming yearly payment alert' | 'User email changed' | 'User email confirmation instructions' | 'Xero OAuth error' | 'Xero sync error notification', nullable
    - `category_code` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52, nullable — | Enum Value | Description | |---|---| | 1 | Appointment Reminder | | 2 | Patient Reply Forwarded | | 3 | Invoice | | 4 | Appointment Confirmation | | 5 | Letter | | 6 | Practitioner Appointment Notification | | 7 | SMS Message | | 8 | Reply from Patient | | 9 | Account Statement | | 10 | Cancelled appointment notification | | 11 | Auth Code | | 12 | Memo | | 13 | Reply from Practitioner | | 14 | Payment Receipt | | 15 | Bulk Email | | 16 | Appointment Cancellation | | 17 | Patient Form | | 18 | Upcoming appointments | | 19 | Completed Patient Form | | 20 | Online payment request | | 21 | New user | | 22 | Referred user signed up | | 23 | Referring user bonus notification | | 24 | Referred user bonus notification | | 25 | Password changed | | 26 | Data export complete notification | | 27 | SMS credit purchase reminder | | 28 | SMS credit purchase failed | | 29 | SMS credit purchase requires confirmation | | 30 | SMS credit purchase receipt | | 31 | Xero sync error notification | | 32 | Xero OAuth error | | 33 | Mailchimp integration disconnected | | 34 | Card automatically updated notification | | 35 | Card expiring notification | | 36 | Upcoming yearly payment alert | | 37 | Trial payment failure | | 38 | Subscription payment failure | | 39 | Trial ending reminder | | 40 | Stripe receipt | | 41 | Today's appointments for practitioner | | 42 | User email confirmation instructions | | 43 | User email changed | | 44 | Unlock instructions | | 45 | Reset password instructions | | 46 | Account ownership information updated | | 47 | Email OTP code | | 48 | Appointment Follow Up Message | | 49 | Subscription initiation alert | | 50 | Patient form renewal | | 51 | Rescheduled Appointment Notification | | 52 | Treatment note |
    - `content` string, nullable
    - `content_subject` string, nullable
    - `created_at` string, date-time
    - `direction_code` 1 | 2, nullable — | Enum Value | Description | |---|---| | 1 | Sent | | 2 | Received |
    - `direction_description` 'Received' | 'Sent', nullable
    - `from` string, nullable
    - `id` string, int64
    - `invoice` object
      - `links` object
        - `self` string, uri
    - `letter` object
      - `links` object
        - `self` string, uri
    - `links` object
      - `self` string, uri
    - `patient` object
      - `links` object
        - `self` string, uri
    - `payment` object
      - `links` object
        - `self` string, uri
    - `to` string, nullable
    - `treatment_note` object
      - `links` object
        - `self` string, uri
    - `type` 'Email' | 'Other' | 'Phone call' | 'SMS', nullable
    - `type_code` 1 | 2 | 3 | 4, nullable — | Enum Value | Description | |---|---| | 1 | SMS | | 2 | Email | | 3 | Phone call | | 4 | Other |
    - `updated_at` string, date-time
  - object
    - `archived_at` string, date-time, nullable
    - `attendee` object
      - `links` object
        - `self` string, uri
    - `booking` object
      - `links` object
        - `self` string, uri
    - `category` 'Account Statement' | 'Account ownership information updated' | 'Appointment Cancellation' | 'Appointment Confirmation' | 'Appointment Follow Up Message' | 'Appointment Reminder' | 'Auth Code' | 'Bulk Email' | 'Cancelled appointment notification' | 'Card automatically updated notification' | 'Card expiring notification' | 'Completed Patient Form' | 'Data export complete notification' | 'Email OTP code' | 'Invoice' | 'Letter' | 'Mailchimp integration disconnected' | 'Memo' | 'New user' | 'Online payment request' | 'Password changed' | 'Patient Form' | 'Patient Reply Forwarded' | 'Patient form renewal' | 'Payment Receipt' | 'Practitioner Appointment Notification' | 'Referred user bonus notification' | 'Referred user signed up' | 'Referring user bonus notification' | 'Reply from Patient' | 'Reply from Practitioner' | 'Rescheduled Appointment Notification' | 'Reset password instructions' | 'SMS Message' | 'SMS credit purchase failed' | 'SMS credit purchase receipt' | 'SMS credit purchase reminder' | 'SMS credit purchase requires confirmation' | 'Stripe receipt' | 'Subscription initiation alert' | 'Subscription payment failure' | 'Today's appointments for practitioner' | 'Treatment note' | 'Trial ending reminder' | 'Trial payment failure' | 'Unlock instructions' | 'Upcoming appointments' | 'Upcoming yearly payment alert' | 'User email changed' | 'User email confirmation instructions' | 'Xero OAuth error' | 'Xero sync error notification', nullable
    - `category_code` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52, nullable — | Enum Value | Description | |---|---| | 1 | Appointment Reminder | | 2 | Patient Reply Forwarded | | 3 | Invoice | | 4 | Appointment Confirmation | | 5 | Letter | | 6 | Practitioner Appointment Notification | | 7 | SMS Message | | 8 | Reply from Patient | | 9 | Account Statement | | 10 | Cancelled appointment notification | | 11 | Auth Code | | 12 | Memo | | 13 | Reply from Practitioner | | 14 | Payment Receipt | | 15 | Bulk Email | | 16 | Appointment Cancellation | | 17 | Patient Form | | 18 | Upcoming appointments | | 19 | Completed Patient Form | | 20 | Online payment request | | 21 | New user | | 22 | Referred user signed up | | 23 | Referring user bonus notification | | 24 | Referred user bonus notification | | 25 | Password changed | | 26 | Data export complete notification | | 27 | SMS credit purchase reminder | | 28 | SMS credit purchase failed | | 29 | SMS credit purchase requires confirmation | | 30 | SMS credit purchase receipt | | 31 | Xero sync error notification | | 32 | Xero OAuth error | | 33 | Mailchimp integration disconnected | | 34 | Card automatically updated notification | | 35 | Card expiring notification | | 36 | Upcoming yearly payment alert | | 37 | Trial payment failure | | 38 | Subscription payment failure | | 39 | Trial ending reminder | | 40 | Stripe receipt | | 41 | Today's appointments for practitioner | | 42 | User email confirmation instructions | | 43 | User email changed | | 44 | Unlock instructions | | 45 | Reset password instructions | | 46 | Account ownership information updated | | 47 | Email OTP code | | 48 | Appointment Follow Up Message | | 49 | Subscription initiation alert | | 50 | Patient form renewal | | 51 | Rescheduled Appointment Notification | | 52 | Treatment note |
    - `content` string, nullable
    - `created_at` string, date-time
    - `direction_code` 1 | 2, nullable — | Enum Value | Description | |---|---| | 1 | Sent | | 2 | Received |
    - `direction_description` 'Received' | 'Sent', nullable
    - `from` string, nullable
    - `id` string, int64
    - `invoice` object
      - `links` object
        - `self` string, uri
    - `letter` object
      - `links` object
        - `self` string, uri
    - `links` object
      - `self` string, uri
    - `patient` object
      - `links` object
        - `self` string, uri
    - `payment` object
      - `links` object
        - `self` string, uri
    - `to` string, nullable
    - `type` 'Email' | 'Other' | 'Phone call' | 'SMS', nullable
    - `type_code` 1 | 2 | 3 | 4, nullable — | Enum Value | Description | |---|---| | 1 | SMS | | 2 | Email | | 3 | Phone call | | 4 | Other |
    - `updated_at` string, date-time

---

[API](https://skmtc.net/cliniko/apis/cliniko-api.md) · [All operations](https://skmtc.net/cliniko/apis/cliniko-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cliniko/cliniko-api/revisions/ffc3ab3f8ea0/schema)