Get Patient

curl --request GET \
  --url https://api.example.com/v1/patients/{id} \
  --header 'X-API-Key: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "phone_number": "<string>",
  "additional_phone_number": "<string>",
  "email": "<string>",
  "date_of_birth": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "workflow_stage_id": "<string>",
  "assigned_user_id": "<string>",
  "location_id": "<string>",
  "organization_id": "<string>",
  "active": true,
  "version": 1,
  "first_communication_at": "<string>",
  "custom_fields": {},
  "comments": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "workflow_stage": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "actions": [],
    "order": 123,
    "description": "<string>"
  },
  "assigned_user": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "referrals": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "physician_name": "<string>",
      "physician_email": "<string>",
      "physician_phone": "<string>",
      "physician_fax": "<string>",
      "physician_group": "<string>",
      "physician_npi": "<string>",
      "physician_address": "<string>",
      "physician_address_2": "<string>",
      "physician_city": "<string>",
      "physician_zip": "<string>",
      "icd_codes": [
        "<string>"
      ],
      "service_types": [],
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "location_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "payors": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "<string>",
      "updated_at": "<string>",
      "patient_id": "<string>",
      "insurance_id": "<string>",
      "subscriber_id": "<string>",
      "insured_member_id": "<string>",
      "group_number": "<string>",
      "group_description": "<string>",
      "medicaid_id": "<string>",
      "coverage_from": "<string>",
      "coverage_to": "<string>",
      "plan_name": "<string>",
      "cob_notes": "<string>",
      "cob_last_verified_at": "<string>",
      "has_other_active_coverage": true,
      "out_of_state_benefits": true,
      "out_of_state_benefits_comments": "<string>",
      "in_grace_period": true,
      "last_payment_date": "<string>",
      "is_cobra_coverage": true,
      "deductible_apply_to_oop": true,
      "copay_applies_to_oop_max": true,
      "eligibility_check_status": "pending",
      "eligibility_check_comment": "<string>",
      "eligibility_check_date": "<string>",
      "eligibility_version": 0,
      "individual_deductible_policy_in_network": 123,
      "individual_deductible_policy_out_network": 123,
      "individual_deductible_remaining_in_network": 123,
      "individual_deductible_remaining_out_network": 123,
      "family_deductible_policy_in_network": 123,
      "family_deductible_policy_out_network": 123,
      "family_deductible_remaining_in_network": 123,
      "family_deductible_remaining_out_network": 123,
      "individual_oop_max_policy_in_network": 123,
      "individual_oop_max_policy_out_network": 123,
      "individual_oop_max_remaining_in_network": 123,
      "individual_oop_max_remaining_out_network": 123,
      "family_oop_max_policy_in_network": 123,
      "family_oop_max_policy_out_network": 123,
      "family_oop_max_remaining_in_network": 123,
      "family_oop_max_remaining_out_network": 123,
      "benefits_related_entities": [
        {}
      ],
      "ai_summary": "<string>",
      "ai_summary_generated_at": "<string>",
      "patient": {},
      "insurance": {},
      "subscriber": {},
      "services": [
        {
          "copay_in_network": 25,
          "created_at": "2024-01-15T10:30:00Z",
          "eligibility_check_status": "ELIGIBLE",
          "id": "550e8400-e29b-41d4-a716-446655440014",
          "payor_id": "550e8400-e29b-41d4-a716-446655440012",
          "service_type": "PT",
          "updated_at": "2024-01-15T10:30:00Z",
          "verification_benefits_status": "VERIFIED"
        }
      ],
      "active": true,
      "version": 1
    }
  ],
  "external_id_values": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "external_id_type": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

GET

patients

{id}

Get Patient

curl --request GET \
  --url https://api.example.com/v1/patients/{id} \
  --header 'X-API-Key: <api-key>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "phone_number": "<string>",
  "additional_phone_number": "<string>",
  "email": "<string>",
  "date_of_birth": "<string>",
  "address": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "workflow_stage_id": "<string>",
  "assigned_user_id": "<string>",
  "location_id": "<string>",
  "organization_id": "<string>",
  "active": true,
  "version": 1,
  "first_communication_at": "<string>",
  "custom_fields": {},
  "comments": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "workflow_stage": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "actions": [],
    "order": 123,
    "description": "<string>"
  },
  "assigned_user": {
    "id": "<string>",
    "name": "<string>",
    "email": "<string>"
  },
  "referrals": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "physician_name": "<string>",
      "physician_email": "<string>",
      "physician_phone": "<string>",
      "physician_fax": "<string>",
      "physician_group": "<string>",
      "physician_npi": "<string>",
      "physician_address": "<string>",
      "physician_address_2": "<string>",
      "physician_city": "<string>",
      "physician_zip": "<string>",
      "icd_codes": [
        "<string>"
      ],
      "service_types": [],
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "location_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "payors": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "<string>",
      "updated_at": "<string>",
      "patient_id": "<string>",
      "insurance_id": "<string>",
      "subscriber_id": "<string>",
      "insured_member_id": "<string>",
      "group_number": "<string>",
      "group_description": "<string>",
      "medicaid_id": "<string>",
      "coverage_from": "<string>",
      "coverage_to": "<string>",
      "plan_name": "<string>",
      "cob_notes": "<string>",
      "cob_last_verified_at": "<string>",
      "has_other_active_coverage": true,
      "out_of_state_benefits": true,
      "out_of_state_benefits_comments": "<string>",
      "in_grace_period": true,
      "last_payment_date": "<string>",
      "is_cobra_coverage": true,
      "deductible_apply_to_oop": true,
      "copay_applies_to_oop_max": true,
      "eligibility_check_status": "pending",
      "eligibility_check_comment": "<string>",
      "eligibility_check_date": "<string>",
      "eligibility_version": 0,
      "individual_deductible_policy_in_network": 123,
      "individual_deductible_policy_out_network": 123,
      "individual_deductible_remaining_in_network": 123,
      "individual_deductible_remaining_out_network": 123,
      "family_deductible_policy_in_network": 123,
      "family_deductible_policy_out_network": 123,
      "family_deductible_remaining_in_network": 123,
      "family_deductible_remaining_out_network": 123,
      "individual_oop_max_policy_in_network": 123,
      "individual_oop_max_policy_out_network": 123,
      "individual_oop_max_remaining_in_network": 123,
      "individual_oop_max_remaining_out_network": 123,
      "family_oop_max_policy_in_network": 123,
      "family_oop_max_policy_out_network": 123,
      "family_oop_max_remaining_in_network": 123,
      "family_oop_max_remaining_out_network": 123,
      "benefits_related_entities": [
        {}
      ],
      "ai_summary": "<string>",
      "ai_summary_generated_at": "<string>",
      "patient": {},
      "insurance": {},
      "subscriber": {},
      "services": [
        {
          "copay_in_network": 25,
          "created_at": "2024-01-15T10:30:00Z",
          "eligibility_check_status": "ELIGIBLE",
          "id": "550e8400-e29b-41d4-a716-446655440014",
          "payor_id": "550e8400-e29b-41d4-a716-446655440012",
          "service_type": "PT",
          "updated_at": "2024-01-15T10:30:00Z",
          "verification_benefits_status": "VERIFIED"
        }
      ],
      "active": true,
      "version": 1
    }
  ],
  "external_id_values": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "external_id_type": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Path Parameters

string<uuid>

required

Query Parameters

expand[]

enum<string>[] | null

Fields to expand in the response

Allowed expand values for patient endpoints

Available options:

tags,

workflow_stage,

assigned_user,

referrals,

payors,

external_id_values

status

enum<string> | null

default:active

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

Available options:

active,

inactive,

all

Response

Successful Response

Patient resource response model.

string<uuid>

required

created_at

string | null

required

updated_at

string | null

required

first_name

string | null

last_name

string | null

middle_name

string | null

phone_number

string | null

additional_phone_number

string | null

date_of_birth

string | null

gender

enum<string> | null

Gender enum matching Prisma

Available options:

male,

female,

other

address

string | null

address2

string | null

city

string | null

state

enum<string> | null

US States enum matching Prisma @map values

Available options:

alabama,

alaska,

arizona,

arkansas,

california,

colorado,

connecticut,

delaware,

florida,

georgia,

hawaii,

idaho,

illinois,

indiana,

iowa,

kansas,

kentucky,

louisiana,

maine,

maryland,

massachusetts,

michigan,

minnesota,

mississippi,

missouri,

montana,

nebraska,

nevada,

new_hampshire,

new_jersey,

new_mexico,

new_york,

north_carolina,

north_dakota,

ohio,

oklahoma,

oregon,

pennsylvania,

rhode_island,

south_carolina,

south_dakota,

tennessee,

texas,

utah,

vermont,

virginia,

washington,

west_virginia,

wisconsin,

wyoming,

district_of_columbia,

puerto_rico,

virgin_islands,

guam,

northern_mariana_islands,

american_samoa

zip

string | null

workflow_stage_id

string | null

assigned_user_id

string | null

location_id

string | null

organization_id

string | null

created_from

enum<string> | null

Patient creation source enum matching Prisma

Available options:

form,

call,

api,

file,

sms,

fax,

chat_agent,

manual,

bulk_import,

eligibility

active

boolean

default:true

version

integer

default:1

first_communication_at

string | null

custom_fields

Custom Fields · object

comments

string | null