---
title: "View communication logs (beta)"
method: GET
path: "/communication_logs"
tags: ["Communication Logs"]
---

# View communication logs (beta)

`GET /communication_logs`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/communication_logs`
- Auth: API key in header `Authorization`

> 🚧 Beta
>
> Send `Nex-Api-Version: v3.1.0` to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

This endpoint lists the communication log requests made through this API at the given location, each with the status of its write-back to the EHR (`in_progress`, `succeeded` or `failed`). Filter by `patient_id`, `status` or `created_since`. Only requests registered in the last 30 days are listed unless `created_since` reaches further back, up to 90 days. Entries recorded directly in the EHR are not available. Communication logs exist only for Open Dental locations, the only EHR the write-back currently supports.

## Query parameters

- `subdomain` string, required
- `location_id` integer, required
- `patient_id` integer
- `status` 'in_progress' | 'succeeded' | 'failed'
- `created_since` string, date-time
- `sort` string
- `start_cursor` string
- `end_cursor` string
- `per_page` integer

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesCommunicationLogCreateDirectiveCollectionResponseWithCursor: API_V31_Entities_CommunicationLogCreateDirective_Collection_Response_WithCursor model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV31EntitiesCommunicationLogCreateDirective[]
    - `id` string: ID of the communication log request (UUID)
    - `patient_id` integer: Patient ID
    - `location_id` integer: Location ID
    - `mode` 'phone' | 'text' | 'email' | 'mail' | 'in_person': How the practice and the patient communicated
    - `direction` 'sent' | 'received': Whether the practice sent or received the communication. Null when the exchange had no single direction, such as a two-way text conversation
    - `note` string: Body of the log entry, written to the EHR verbatim
    - `occurred_at` string, date-time: When the communication happened, in UTC
    - `status` 'in_progress' | 'succeeded' | 'failed': Status of the write-back to the EHR: `in_progress` until the EHR integration reports back, then `succeeded` or `failed`
    - `completed_at` string, date-time: When the write-back reached its final status. Null while in progress
    - `created_at` string, date-time: When the request was registered, in UTC
  - `page_info` object: Pagination information that can be used for fetching previous and next pages.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)