---
title: "Search Patient"
method: POST
path: "/api/v2/patients/search"
tags: ["Patients"]
---

# Search Patient

`POST /api/v2/patients/search`

## Request

- Base URL: `https://sandbox.particlehealth.com`
- URL: `https://sandbox.particlehealth.com/api/v2/patients/search`
- Auth: API key in header `Authorization`

## Request body

- ApiPatient
  - `address_city` string, required: The patient's home city.
  - `address_lines` string[]: The patient's home street address. This should not include the patient's city, state, or zip code.
  - `address_state` string, required: The patient's home state.
  - `consent` ApiConsent[]: The patient's consent information.
    - `consent_date` string, required
    - `partner` string, required
    - `permission` 'permit' | 'deny', required
  - `date_of_birth` string, required: The patient's date of birth, this field is required and must be of the format YYYY-MM-DD.
  - `email` string: The patient's email, must be a valid email address.
  - `family_name` string, required: The patient's family name (last name), this field is required.
  - `filter` 'signal_enrolled': Optional filter for the search endpoint (`POST /api/v2/patients/search`). Supported value: `signal_enrolled`, which restricts matches to patients enrolled in Signal monitoring. If your project monitors all patients, all of its patients are eligible. Input only, not returned in responses.
  - `gender` string, required: The patient's gender, must be either FEMALE or MALE.
  - `given_name` string, required: The patient's given name (first name), this field is required.
  - `particle_patient_id` string: The Particle Assigned Patient ID. Output only.
  - `patient_id` string, required: The unique patient id in an external system.
  - `postal_code` string, required: The patient's home postal (zip) code.
  - `ssn` string: The patient's social security number, must be a valid US social security number.
  - `telephone` string: The patient's telephone number.

## Response `200`

OK

- ApiPatient[]
  - `address_city` string, required: The patient's home city.
  - `address_lines` string[]: The patient's home street address. This should not include the patient's city, state, or zip code.
  - `address_state` string, required: The patient's home state.
  - `consent` ApiConsent[]: The patient's consent information.
    - `consent_date` string, required
    - `partner` string, required
    - `permission` 'permit' | 'deny', required
  - `date_of_birth` string, required: The patient's date of birth, this field is required and must be of the format YYYY-MM-DD.
  - `email` string: The patient's email, must be a valid email address.
  - `family_name` string, required: The patient's family name (last name), this field is required.
  - `filter` 'signal_enrolled': Optional filter for the search endpoint (`POST /api/v2/patients/search`). Supported value: `signal_enrolled`, which restricts matches to patients enrolled in Signal monitoring. If your project monitors all patients, all of its patients are eligible. Input only, not returned in responses.
  - `gender` string, required: The patient's gender, must be either FEMALE or MALE.
  - `given_name` string, required: The patient's given name (first name), this field is required.
  - `particle_patient_id` string: The Particle Assigned Patient ID. Output only.
  - `patient_id` string, required: The unique patient id in an external system.
  - `postal_code` string, required: The patient's home postal (zip) code.
  - `ssn` string: The patient's social security number, must be a valid US social security number.
  - `telephone` string: The patient's telephone number.

## Other responses

- `204`: No Content
- `400`: Bad Request
- `401`: Unauthorized
- `406`: Not Acceptable
- `500`: Internal Server Error

## Changes

- **2026-11-03** `b59a5413a488`: 7 info
  - added the new optional request property `filter`
  - added the optional property `error_code` to the response with the `204` status
  - added the optional property `error_code` to the response with the `400` status
  - added the optional property `error_code` to the response with the `401` status
  - …3 more

[Operation history](https://skmtc.dev/particlehealth/apis/particle-health-api/changes/api/v2/patients/search/post.md)

---

[API](https://skmtc.dev/particlehealth/apis/particle-health-api.md) - [All operations](https://skmtc.dev/particlehealth/apis/particle-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/particlehealth/apis/particle-health-api/revisions/b59a5413a488?raw)