NEnexhealth
Communication Logs

View communication logs (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 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.

get/communication_logs

Request

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

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

patient_idinteger

Filter by patient

status'in_progress' | 'succeeded' | 'failed'

Filter by write-back status

created_sincestring date-time

Requests registered after the specified time (UTC). Defaults to 30 days ago and cannot be more than 90 days ago

sortstring

Optional comma-separated string of fields to sort on. Include a leading dash for descending order.

Available fields:

  • created_at
  • -created_at
start_cursorstring

First item of the current page. Starts empty

end_cursorstring

Last item of the current page. Starts empty

per_pageinteger

Number of results to return per page. Maximum allowed amount is 1000.

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.

page_infoobject

Pagination information that can be used for fetching previous and next pages.

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"
    }
  ],
  "page_info": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "AAAAA",
    "end_cursor": "BBBBBB"
  }
}

Changes

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