Sign in

v1

latestOpenAPI 3.1.02026-07-2218105157.9 KB
Patients

List Patients

get/v1/patients

Query parameters

workflow_stage_ids[]string[] nullable

Filter by multiple workflow stage IDs (OR)

Filter by multiple workflow stage IDs (OR)

include_unassignedboolean

Include patients with no workflow stage (combines with workflow_stage_ids via OR)

Include patients with no workflow stage (combines with workflow_stage_ids via OR)

tags[]string[] nullable

Filter by tag IDs

Filter by tag IDs

insurance_ids[]string[] nullable

Filter by insurance IDs

Filter by insurance IDs

states[]States[] nullable

Filter by states

Filter by states

location_ids[]string[] nullable

Filter by company location IDs

Filter by company location IDs

organization_ids[]string[] nullable

Filter by company organization IDs

Filter by company organization IDs

created_from[]PatientCreatedFrom[] nullable

Filter by created_from sources

Filter by created_from sources

eligibility_status[]EligibilityStatus[] nullable

Filter by eligibility check status

Filter by eligibility check status

eligibility_filter_mode'any' | 'primary' | 'secondary' | 'tertiary' | 'quaternary'

Eligibility filter mode — which payor tier to check, or any

Eligibility filter mode

sync_status[]SyncStatus[] nullable

Filter by sync status

Filter by sync status

plan_namestring nullable

Filter by plan name (partial match)

Filter by plan name (partial match)

plan_types[]InsurancePlanType[] nullable

Filter by plan types

Filter by plan types

group_descriptionstring nullable

Filter by group description (partial match)

Filter by group description (partial match)

group_numberstring nullable

Filter by group number (partial match)

Filter by group number (partial match)

expand[]PatientExpand[] nullable

Fields to expand in the response

Fields to expand in the response

pageinteger nullable
limitinteger nullable
qstring nullable
idstring uuid nullable
workflow_stage_idstring nullable
assigned_tostring nullable
status'active' | 'inactive' | 'all'

Filter options for patient status (active/inactive/all)

phone_numberstring nullable
emailstring nullable
external_idstring nullable
first_namestring nullable
last_namestring nullable
date_of_birthstring nullable
tag_filter_mode'any' | 'all' | 'exclude_any' | 'exclude_all'

Tag filter mode for patient queries

created_gtestring date-time nullable
created_ltestring date-time nullable
updated_gtestring date-time nullable
updated_ltestring date-time nullable

Response

Successful Response

Example response

{
  "data": [
    {
      "active": true,
      "created_at": "2024-01-15T10:30:00Z",
      "date_of_birth": "1990-01-15",
      "email": "john.doe@example.com",
      "first_name": "John",
      "id": "550e8400-e29b-41d4-a716-446655440009",
      "last_name": "Doe",
      "phone_number": "+1234567890",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "has_more": false,
    "limit": 50,
    "page": 1,
    "total": 1
  }
}