NEnexhealth
Communication Logs

View communication log (beta)

🚧 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 returns a communication log request made through this API, with the status of its write-back to the EHR. 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.

get/communication_logs/{id}

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/communication_logs/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Query parameters

subdomainstring required

Used to scope the request to the specified institution

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": "019965f2-4d1e-7a3c-9b0e-3f0c2a7d9e11",
    "patient_id": 162,
    "location_id": 21,
    "mode": "phone",
    "direction": "received",
    "note": "AI receptionist call summary: patient confirmed the cleaning on Tuesday at 10am.",
    "occurred_at": "2026-09-01T14:30:00.000Z",
    "status": "succeeded",
    "completed_at": "2026-09-01T14:31:07.000Z",
    "created_at": "2026-09-01T14:30:05.000Z"
  },
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.