---
title: "View patient recalls"
method: GET
path: "/patient_recalls"
tags: ["Patient Recalls"]
---

# View patient recalls

`GET /patient_recalls`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/patient_recalls`
- Auth: API key in header `Authorization`

This endpoint returns the patient recalls for the specified location, narrowed down by the optional filters configured.

## Query parameters

- `subdomain` string, required
- `start_cursor` string
- `end_cursor` string
- `per_page` integer
- `location_id` integer, required
- `recall_id` integer
- `patient_id` integer
- `foreign_id` string
- `updated_since` string, date-time
- `due_after` string, date-time
- `sort` string

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV2EntitiesPatientRecallCollectionResponseWithCursor: API_V2_Entities_PatientRecall_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` APIV2EntitiesPatientRecall[]
    - `id` integer: Object identifier
    - `appointment_id` integer, nullable: Id of the associated appointment
    - `date_due` string, date, nullable: Date the patient is due for this recall
    - `foreign_id` string: EHR id
    - `foreign_id_type` string: EHR type
    - `recall_id` integer, nullable: Id of the associated recall type
    - `recall_type` APIV2EntitiesPatientRecallType
      - `id` integer: Object identifier
      - `name` string: Recall name
      - `description` string: Recall description
      - `interval_num` integer: The length of the interval
      - `interval_unit` string: The interval unit
    - `patient_id` integer, nullable: Id of the associated patient
    - `created_at` string, date-time: Timestamp of initial creation in UTC
    - `updated_at` string, date-time: Timestamp of most recent change in UTC
  - `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.dev/nexhealth/apis/nexhealth-api.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api/revisions/a180e830b672?raw)