---
title: "View sync status (beta)"
method: GET
path: "/sync_status"
tags: ["Sync Status"]
---

# View sync status (beta)

`GET /sync_status`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/sync_status`
- 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.

> **Changed from v3.0.0:** Adds response fields `data[].ehr`, `data[].ehr.display_name`, `data[].ehr.id`, `data[].ehr.name` (+1 more); removes response fields `data[].emr`, `data[].emr.display_name`, `data[].emr.id`, `data[].emr.name` (+1 more).

This endpoint returns EHR sync statuses for the institution's locations, optionally filtered by `location_ids`, `read_status`, or `write_status`.

## Query parameters

- `subdomain` string
- `read_status` 'green' | 'red'
- `write_status` 'green' | 'red'
- `location_ids[]` integer[]

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesSyncStatusCollectionResponse: API_V31_Entities_SyncStatus_Collection_Response 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` APIV31EntitiesSyncStatus[]
    - `institution_id` integer: Institution ID
    - `sync_source_type` string: Source type
    - `sync_source_name` string: Source name
    - `read_status` 'green' | 'red': Status of the read service, where green means up, red means down
    - `read_status_at` string, date-time: Last time NexHealth read data from the EHR, in UTC
    - `write_status` 'green' | 'red': Status of the write service, where green means up, red means down
    - `write_status_at` string, date-time: Last time the sync picked up write commands from NexHealth, in UTC
    - `locations` APIV2EntitiesLocationBasic[]: Locations whose data this service is synchronizing with
      - `id` integer: Location ID
      - `name` string: Location name
      - `street_address` string: Location street address
      - `street_address_2` string: Location street address 2
      - `city` string: Location city
      - `state` string: 2 letter state code
      - `zip_code` string: Patient zip code
      - `phone_number` string: Practice phone number
      - `email` string: Location email ID
      - `inactive` boolean: Is this location not being actively used?
    - `ehr` APIV31EntitiesEhr
      - `id` integer: EHR ID
      - `name` string: EHR name
      - `display_name` string: EHR display name
      - `type` 'cloud' | 'onprem': Type of EHR. Can be cloud or onprem.
  - `count` integer: Number of total objects, in case of collection.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `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)