Get Orders

Authorizations

x-vital-api-key

string

header

required

Vital Team API Key

Query Parameters

search_input

string | null

Search by order id, user id, patient name, shipping dob, or shipping recipient name.

start_date

string | null

Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00

end_date

string | null

Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59

updated_start_date

string | null

Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00

updated_end_date

string | null

Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00

order_key

enum<string> | null

Available options:

created_at,

patient_name,

last_status

order_direction

enum<string> | null

Available options:

asc,

desc

user_id

string | null

Filter by user ID.

patient_name

string | null

Filter by patient name.

shipping_recipient_name

string | null

Filter by shipping recipient name.

order_ids

string[] | null

Filter by order ids.

page

integer

default:

Required range: x > 1

size

integer

default:

Required range: 1 < x < 100

Response

200 - application/json

orders

object[]

required

orders.created_at

string

required

When your order was created

orders.details

object

required

orders.events

object[]

required

orders.health_insurance_id

string | null

required

Vital ID of the health insurance.

orders.id

string

required

The Vital Order ID

orders.lab_test

object

required

The Vital Test associated with the order

orders.lab_test.id

string

required

orders.lab_test.is_active

boolean

required

Deprecated. Use status instead.

orders.lab_test.lab

object | null

required

orders.lab_test.markers

object[] | null

required

orders.lab_test.method

enum<string>

required

Available options:

testkit,

walk_in_test,

at_home_phlebotomy

orders.lab_test.name

string

required

orders.lab_test.price

number

required

orders.lab_test.sample_type

enum<string>

required

Available options:

dried_blood_spot,

arm_collector,

serum,

saliva,

urine

orders.lab_test.slug

string

required

orders.lab_test.status

enum<string>

required

Available options:

active,

pending_approval,

inactive

orders.lab_test.auto_generated

boolean

default:

false

Whether the lab test was auto-generated by Vital

orders.lab_test.fasting

boolean

default:

false

Defines whether a lab test requires fasting.

orders.lab_test.is_delegated

boolean

default:

false

Denotes whether a lab test requires using non-Vital physician networks. If it does then it's delegated - no otherwise.

orders.notes

string | null

required

Notes associated with the order

orders.patient_address

object | null

required

Patient Address

orders.patient_details

object | null

required

Patient Details

orders.requisition_form_url

string | null

required

DEPRECATED. Requistion form url.

orders.sample_id

string | null

required

Sample ID

orders.shipping_details

object | null

required

Shipping Details. For unregistered testkit orders.

orders.team_id

string

required

Your team id.

orders.updated_at

string

required

When your order was last updated.

orders.user_id

string

required

User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.

orders.activate_by

string | null

Schedule an Order to be processed in a future date.

orders.billing_type

enum<string>

Available options:

client_bill,

commercial_insurance,

patient_bill_passthrough,

patient_bill

orders.icd_codes

string[] | null

orders.passthrough

string | null

orders.physician

object | null

orders.priority

boolean

default:

false

Defines whether order is priority or not. For some labs, this refers to a STAT order.

orders.status

enum<string> | null

Available options:

received,

collecting_sample,

sample_with_lab,

completed,

cancelled,

failed

page

integer | null

size

integer | null

total

integer | null

Orders

Area Info

At-home Phlebotomy

Patient Service Center (PSC)

Tests

Results

Health Insurance

Authorizations

Query Parameters

Response