---
title: "View institutions (beta)"
method: GET
path: "/institutions"
tags: ["Institutions"]
---

# View institutions (beta)

`GET /institutions`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/institutions`
- 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 field `data[].ehrs`; removes response field `data[].emrs`.

This endpoint returns all institutions accessible to the authenticated API user.

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesInstitutionCollectionResponse: API_V31_Entities_Institution_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` APIV31EntitiesInstitution[]
    - `id` integer: Institution ID
    - `name` string: Name of the institution
    - `created_at` string, date-time: Institution created time in UTC
    - `updated_at` string, date-time: Institution last updated time in UTC
    - `subdomain` string: Data partitioned subdomain name
    - `phone_number` string: Institution contact number
    - `country_code` string: 2- or 3-letter country code for country
    - `appointment_types_location_scoped` boolean: Does each location have its own appointment types?
    - `is_sync_notifications` boolean: Receive's emails when sync connection goes down
    - `notify_insert_fails` boolean: Receive's emails on appointment insert fail
    - `locations` APIV2EntitiesLocationBasic[]: Collection of locations
      - `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?
    - `ehrs` string[]: Array of strings of EHRs used by this institution
  - `count` integer: Number of total objects, in case of collection.

## Other responses

- `401`: Unauthorized
- `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)