---
title: "Search"
method: GET
path: "/user/patient/search"
tags: ["provider", "user"]
---

# Search

`GET /user/patient/search`

Search for a patient by name, phone number, ID, or date of birth.

## Query parameters

- `search_term` string, nullable — Search query for patient, could be the phone number, first or last name, external id, or date of birth.
- `n` integer, nullable — Number of results to return

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- PatientSummaryWithMemberships[]
  - `id` string, required — The unique identifier for the user.
  - `firstName` string, nullable — The user's first name.
  - `lastName` string, nullable — The user's last name.
  - `phoneNumber` string, nullable — The user's phone number.
  - `email` string, nullable — The user's email address.
  - `type` 'PROVIDER' | 'PATIENT' | 'ASSISTANT', required
  - `locationId` string, nullable — The location of the user.
  - `externalId` string, nullable — The user's external identifier if available.
  - `address` string, nullable — The user's primary address.
  - `addressLineTwo` string, nullable — Additional address information.
  - `city` string, nullable — The city of the user's address.
  - `state` string, nullable — The state of the user's address.
  - `zipCode` string, nullable — The postal code of the user's address.
  - `country` string, nullable — The country of the user's address.
  - `createdDate` string, date-time, required — The date and time when the user was created.
  - `addressValid` boolean, nullable — Whether the user's address is valid.
  - `meta` object, nullable — Any additional metadata about the user relevant to your system.
  - `isArchived` boolean, nullable — Whether the user is archived.
  - `primaryLocationId` string, nullable — The primary location of the user.
  - `gender` string, nullable — The gender of the patient.
  - `dateOfBirth` string, date, nullable — The date of birth of the patient.
  - `patientMedications` string[], nullable — List of patient's self-reported medications.
  - `onSchedulingBlacklist` boolean, nullable — Whether the patient is on the scheduling blacklist.
  - `surchargeDisabled` boolean, nullable — Whether surcharges are disabled for this patient.
  - `tags` PatientTagSummary[], nullable — List of patient tags
    - `id` string, required — Unique identifier for the patient tag
    - `name` string, required — Name of the patient tag
    - `emoji` string, nullable — Emoji associated with the tag
    - `color` string, nullable — Color code for the tag (hex format)
    - `isActive` boolean, required — Whether the tag is active
    - `createdDate` string, date-time, required — Date and time when the tag was created
    - `updatedDate` string, date-time, nullable — Date and time when the tag was last updated
  - `creditBalance` integer, nullable — Patient's credit balance in cents.
  - `preferredProviderId` string, nullable — The preferred provider ID for this patient.
  - `memberships` MemberTiny[], nullable — List of memberships for this patient
    - `id` string, required — Unique identifier for the member
    - `membership` MembershipTiny, required
      - `id` string, required — Unique identifier for the membership
      - `name` string, required — Name of the membership
      - `textColor` string, nullable — Text color of the membership
    - `startDate` string, date-time, required — When the patient joined the membership
    - `status` 'ACTIVE' | 'EXPIRED' | 'CANCELLED' | 'DELINQUENT' | 'FROZEN', required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/decodahealth/apis/decoda-api.md) · [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) · [OpenAPI document](https://skmtc.dev/decodahealth/apis/decoda-api/revisions/4ab18c80f9e9?raw)