---
title: "View patients"
method: GET
path: "/patients"
tags: ["Patients"]
---

# View patients

`GET /patients`

This endpoint returns a list of patients for the specified location, narrowed down by the optional filters configured.

## Query parameters

- `subdomain` string, required
- `location_id` integer, required
- `sort` string
- `name` string
- `email` string
- `phone_number` string
- `date_of_birth` string, date
- `inactive` boolean
- `foreign_id` string
- `updated_since` string, date-time
- `new_patient` boolean
- `non_patient` boolean
- `forms_syncable` boolean
- `location_strict` boolean
- `start_cursor` string
- `end_cursor` string
- `per_page` integer

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV20240412EntitiesPatientWithPrivacyAuthorizationCollectionResponseWithCursor — API_V20240412_Entities_PatientWithPrivacyAuthorization_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` APIV20240412EntitiesPatientWithPrivacyAuthorization[]
    - `id` integer — User id
    - `email` string, nullable — User email
    - `first_name` string — First name
    - `middle_name` string, nullable — Middle name
    - `last_name` string — Last name
    - `name` string — Full name
    - `created_at` string, date-time — User creation date in UTC
    - `updated_at` string, date-time — User last updation date in UTC
    - `institution_id` integer — The institution this user belongs to
    - `foreign_id` string, nullable — Foreign Id is a unique identifier from the integrated system
    - `foreign_id_type` string — Foreign Id type is a unique string identifier for the integrated system
    - `bio` object — Patient biographical data, fields shown in our example response represent all possible data we retrieve but depending on system and what is actually saved in the health records system you cannot assume any field will consistently be returned
    - `inactive` boolean — Is the user inactivated?
    - `last_sync_time` string, date-time, nullable — The most recent time the resource's data changed meaningfully at the source
    - `guarantor_id` integer, nullable — User id of this patient's responsible party
    - `billing_type` string, nullable — Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type
    - `chart_id` string, nullable — User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users
    - `preferred_language` string, nullable — Patient's preferred language as an ISO 639-1 code, if specified in the integrated system
    - `provider_id` integer, nullable — User id of this patient's primary provider
    - `hipaa` APIV2EntitiesPrivacyAuthorization
      - `authorization` boolean — Whether the patient has provided HIPAA authorization
      - `authorization_date` string, date — Date the patient provided HIPAA authorization
      - `privacy` boolean — Whether the patient has acknowledged HIPAA privacy notice
      - `privacy_date` string, date — Date the patient acknowledged HIPAA privacy notice
      - `consent` boolean — Whether the patient has provided HIPAA consent
      - `consent_date` string, date — Date the patient provided HIPAA consent
  - `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.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)