Get Patient

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

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/v1/patients/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/patients/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/patients/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/patients/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "phone_number": "<string>",
  "additional_phone_number": "<string>",
  "email": "<string>",
  "date_of_birth": "2023-12-25",
  "gender": "male",
  "address": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "alabama",
  "zip": "<string>",
  "workflow_stage_id": "<string>",
  "assigned_user_id": "<string>",
  "location_id": "<string>",
  "organization_id": "<string>",
  "created_from": "form",
  "active": true,
  "version": 1,
  "first_communication_at": "2023-11-07T05:31:56Z",
  "has_sync_completed": true,
  "custom_fields": {},
  "comments": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "workflow_stage": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "actions": [
      "verify_insurance"
    ],
    "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_state": "alabama",
      "physician_zip": "<string>",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "location_id": "<string>",
      "icd_codes": [
        "<string>"
      ],
      "service_types": [
        "medical_care"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "payors": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "patient_id": "<string>",
      "insurance_id": "<string>",
      "coverage_chain_id": "<string>",
      "insurance_display_name": "<string>",
      "subscriber_id": "<string>",
      "external_id": "<string>",
      "relationship_to_subscriber": "spouse",
      "insured_member_id": "<string>",
      "group_number": "<string>",
      "group_description": "<string>",
      "medicaid_id": "<string>",
      "payor_responsibility": "primary",
      "coverage_from": "2023-11-07T05:31:56Z",
      "coverage_to": "2023-11-07T05:31:56Z",
      "provider_network_status": "unknown",
      "cbh_status": "active",
      "plan_funding_type": "fully_funded",
      "plan_name": "<string>",
      "plan_type": "01",
      "plan_renewal_date_type": "calendar_year",
      "benefit_period_end_date": "2023-12-25",
      "cob_on_file": true,
      "cob_last_verified_at": "2023-11-07T05:31:56Z",
      "has_other_active_coverage": true,
      "cob_other_coverages": [
        {
          "name": "<string>",
          "position": "primary"
        }
      ],
      "out_of_state_benefits": true,
      "out_of_state_benefits_comments": "<string>",
      "in_grace_period": true,
      "last_payment_date": "2023-12-25",
      "is_cobra_coverage": true,
      "deductible_apply_to_oop": true,
      "eligibility_check_status": "pending",
      "eligibility_check_comment": "<string>",
      "eligibility_check_date": "2023-11-07T05:31:56Z",
      "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": "2023-11-07T05:31:56Z",
      "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"
    }
  ]
}

{
  "type": "validation_error",
  "code": "invalid_parameter",
  "message": "Field validation failed",
  "param": "phone_number"
}

GET

patients

{id}

Get Patient

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

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/v1/patients/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/patients/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/patients/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/patients/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "phone_number": "<string>",
  "additional_phone_number": "<string>",
  "email": "<string>",
  "date_of_birth": "2023-12-25",
  "gender": "male",
  "address": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "alabama",
  "zip": "<string>",
  "workflow_stage_id": "<string>",
  "assigned_user_id": "<string>",
  "location_id": "<string>",
  "organization_id": "<string>",
  "created_from": "form",
  "active": true,
  "version": 1,
  "first_communication_at": "2023-11-07T05:31:56Z",
  "has_sync_completed": true,
  "custom_fields": {},
  "comments": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "workflow_stage": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "actions": [
      "verify_insurance"
    ],
    "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_state": "alabama",
      "physician_zip": "<string>",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "location_id": "<string>",
      "icd_codes": [
        "<string>"
      ],
      "service_types": [
        "medical_care"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "payors": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "patient_id": "<string>",
      "insurance_id": "<string>",
      "coverage_chain_id": "<string>",
      "insurance_display_name": "<string>",
      "subscriber_id": "<string>",
      "external_id": "<string>",
      "relationship_to_subscriber": "spouse",
      "insured_member_id": "<string>",
      "group_number": "<string>",
      "group_description": "<string>",
      "medicaid_id": "<string>",
      "payor_responsibility": "primary",
      "coverage_from": "2023-11-07T05:31:56Z",
      "coverage_to": "2023-11-07T05:31:56Z",
      "provider_network_status": "unknown",
      "cbh_status": "active",
      "plan_funding_type": "fully_funded",
      "plan_name": "<string>",
      "plan_type": "01",
      "plan_renewal_date_type": "calendar_year",
      "benefit_period_end_date": "2023-12-25",
      "cob_on_file": true,
      "cob_last_verified_at": "2023-11-07T05:31:56Z",
      "has_other_active_coverage": true,
      "cob_other_coverages": [
        {
          "name": "<string>",
          "position": "primary"
        }
      ],
      "out_of_state_benefits": true,
      "out_of_state_benefits_comments": "<string>",
      "in_grace_period": true,
      "last_payment_date": "2023-12-25",
      "is_cobra_coverage": true,
      "deductible_apply_to_oop": true,
      "eligibility_check_status": "pending",
      "eligibility_check_comment": "<string>",
      "eligibility_check_date": "2023-11-07T05:31:56Z",
      "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": "2023-11-07T05:31:56Z",
      "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"
    }
  ]
}

{
  "type": "validation_error",
  "code": "invalid_parameter",
  "message": "Field validation failed",
  "param": "phone_number"
}

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<date-time>

required

updated_at

string<date-time>

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<date> | 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,

prior_auth

active

boolean

default:true

version

integer

default:1

first_communication_at

string<date-time> | null

has_sync_completed

boolean | null

Whether a completed external-sync event exists. Populated on patient-list items whose expanded current workflow stage runs external sync; null on other patient responses.

custom_fields

Custom Fields · object | null

comments

string | null

Patients

Patient Batch

Patient External IDs

Prior Authorizations

Monitoring

Get Patient

Authorizations

Path Parameters

Query Parameters

Response