Patients

Search Patient

Changed on Nov 3, 2026

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

address_citystring required

The patient's home city.

address_linesstring[]

The patient's home street address. This should not include the patient's city, state, or zip code.

address_statestring required

The patient's home state.

date_of_birthstring required

The patient's date of birth, this field is required and must be of the format YYYY-MM-DD.

emailstring

The patient's email, must be a valid email address.

family_namestring 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.

genderstring required

The patient's gender, must be either FEMALE or MALE.

given_namestring required

The patient's given name (first name), this field is required.

particle_patient_idstring

The Particle Assigned Patient ID. Output only.

patient_idstring required

The unique patient id in an external system.

postal_codestring required

The patient's home postal (zip) code.

ssnstring

The patient's social security number, must be a valid US social security number.

telephonestring

The patient's telephone number.

Example request

{
  "address_city": "Brooklyn",
  "address_lines": [
    "999 Dev Drive"
  ],
  "address_state": "New York",
  "consent": [
    {
      "consent_date": "2021-01-01",
      "partner": "Healthix",
      "permission": "permit"
    }
  ],
  "date_of_birth": "1954-12-01",
  "email": "john@doe.com",
  "family_name": "Quark",
  "gender": "MALE",
  "given_name": "Kam",
  "particle_patient_id": "1aa50979-1a8e-416d-8c13-a529033cc898",
  "patient_id": "pati-enti-d123-4567",
  "postal_code": "11111",
  "ssn": "123-45-6789",
  "telephone": "234-567-8910"
}

Response