Orders
Get Orders
- Home
- Wearables
- Lab Testing
- API Reference
- Event Catalog
- Changelog
- Users
- Debugging
- Orders
- Area Info
- At-home Phlebotomy
- Tests
- Results
- Health Insurance
- Sleep
- Meal
- Workouts
- Profile
- Activity
- Body
- Menstrual Cycle
- Vitals
- Body
- Activity
- Wellness
- Nutrition
- Team
- Member
- Invite
- Org
- Team API Keys
- Team Custom Credentials
- Team Data Pull Preferences
- Team ETL Pipeline
- Team Scope Requirements
Core
Lab Testing
Summary Data
Timeseries Data
Org Management
Orders
Get Orders
GET many orders with filters.
GET
/
v3
/
orders
x-vital-api-key
string
*
x-vital-api-key
Required
string
Vital Team API Key
start_date
string
start_date
string
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
end_date
string
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
user_id
string
user_id
string
Filter by user ID.
patient_name
string
patient_name
string
Filter by patient name.
shipping_recipient_name
string
shipping_recipient_name
string
Filter by shipping recipient name.
order_ids
array
order_ids
array
Filter by order ids.
page
Page · integer
page
integer
size
Size · integer
size
integer
Authorizations
x-vital-api-key
string
headerrequiredVital Team API Key
Query Parameters
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
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: 1size
integer
default: 50Response
200 - application/json
orders
object[]
requiredorders.user_id
string
requiredUser 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.id
string
requiredThe Vital Order ID
orders.team_id
string
requiredYour team id.
orders.patient_details
object | null
requiredPatient Details
orders.patient_details.first_name
string | null
orders.patient_details.last_name
string | null
orders.patient_details.dob
string
requiredorders.patient_details.gender
string
requiredorders.patient_details.phone_number
string | null
orders.patient_details.email
string | null
orders.patient_address
object | null
requiredPatient Address
orders.patient_address.receiver_name
string
default: orders.patient_address.first_line
string
requiredorders.patient_address.second_line
string | null
orders.patient_address.city
string
requiredorders.patient_address.state
string
requiredorders.patient_address.zip
string
requiredorders.patient_address.country
string
requiredorders.patient_address.phone_number
string | null
orders.lab_test
object
requiredThe Vital Test associated with the order
orders.lab_test.id
string
requiredorders.lab_test.slug
string
requiredorders.lab_test.name
string
requiredorders.lab_test.sample_type
enum<string>
requiredAvailable options:
dried_blood_spot, serum, saliva, urine orders.lab_test.method
enum<string>
requiredAvailable options:
testkit, walk_in_test, at_home_phlebotomy orders.lab_test.price
number
requiredorders.lab_test.is_active
boolean
requiredDeprecated. Use status instead.
orders.lab_test.status
enum<string>
requiredAvailable options:
active, pending_approval, inactive orders.lab_test.fasting
boolean
default: falseDefines whether a lab test requires fasting.
orders.lab_test.lab
object | null
requiredorders.lab_test.lab.id
integer
requiredorders.lab_test.lab.slug
string
requiredorders.lab_test.lab.name
string
requiredorders.lab_test.lab.first_line_address
string
requiredorders.lab_test.lab.city
string
requiredorders.lab_test.lab.zipcode
string
requiredorders.lab_test.lab.collection_methods
enum<string>[]
requiredAvailable options:
testkit, walk_in_test, at_home_phlebotomy orders.lab_test.lab.sample_types
enum<string>[]
requiredAvailable options:
dried_blood_spot, serum, saliva, urine orders.lab_test.markers
object[] | null
requiredorders.lab_test.markers.id
integer
requiredorders.lab_test.markers.name
string
requiredorders.lab_test.markers.slug
string
requiredorders.lab_test.markers.description
string | null
orders.lab_test.markers.lab_id
integer | null
orders.lab_test.markers.provider_id
string | null
orders.lab_test.markers.type
enum<string> | null
Available options:
biomarker, panel orders.lab_test.markers.unit
string | null
orders.lab_test.markers.price
string | null
orders.lab_test.markers.aoe
object | null
orders.lab_test.markers.aoe.questions
object[]
requiredorders.lab_test.markers.aoe.questions.id
integer
requiredorders.lab_test.markers.aoe.questions.required
boolean
requiredorders.lab_test.markers.aoe.questions.code
string
requiredorders.lab_test.markers.aoe.questions.value
string
requiredorders.lab_test.markers.aoe.questions.type
enum<string>
requiredAvailable options:
choice, text, numeric, multi_choice orders.lab_test.markers.aoe.questions.sequence
integer
requiredorders.lab_test.markers.aoe.questions.answers
object[]
requiredorders.lab_test.markers.aoe.questions.answers.id
integer
requiredorders.lab_test.markers.aoe.questions.answers.code
string
requiredorders.lab_test.markers.aoe.questions.answers.value
string
requiredorders.lab_test.markers.aoe.questions.constraint
string | null
orders.lab_test.is_delegated
boolean
default: falseDenotes whether a lab test requires using non-Vital physician networks. If it does then it's delegated - no otherwise.
orders.details
object
requiredorders.details.type
enum<string>
requiredAvailable options:
walk_in_test orders.details.data
object | null
Schema for a walk-in test order in the client facing API.
To be used as part of a ClientFacingOrder.
orders.details.data.id
string
requiredThe Vital walk-in test Order ID
orders.details.data.created_at
string
requiredorders.details.data.updated_at
string
requiredorders.sample_id
string | null
requiredSample ID
orders.notes
string | null
requiredNotes associated with the order
orders.created_at
string
requiredWhen your order was created
orders.updated_at
string
requiredWhen your order was last updated.
orders.events
object[]
requiredorders.events.id
integer
requiredorders.events.created_at
string
requiredorders.events.status
enum<string>
requiredAvailable options:
received.walk_in_test.ordered, received.walk_in_test.requisition_created, completed.walk_in_test.completed, sample_with_lab.walk_in_test.partial_results, failed.walk_in_test.sample_error, cancelled.walk_in_test.cancelled, received.at_home_phlebotomy.ordered, received.at_home_phlebotomy.requisition_created, collecting_sample.at_home_phlebotomy.appointment_pending, collecting_sample.at_home_phlebotomy.appointment_scheduled, collecting_sample.at_home_phlebotomy.draw_completed, collecting_sample.at_home_phlebotomy.appointment_cancelled, completed.at_home_phlebotomy.completed, sample_with_lab.at_home_phlebotomy.partial_results, cancelled.at_home_phlebotomy.cancelled, failed.at_home_phlebotomy.sample_error, received.testkit.ordered, received.testkit.awaiting_registration, received.testkit.requisition_created, received.testkit.registered, collecting_sample.testkit.transit_customer, collecting_sample.testkit.out_for_delivery, collecting_sample.testkit.with_customer, collecting_sample.testkit.transit_lab, sample_with_lab.testkit.delivered_to_lab, completed.testkit.completed, failed.testkit.failure_to_deliver_to_customer, failed.testkit.failure_to_deliver_to_lab, failed.testkit.sample_error, failed.testkit.lost, cancelled.testkit.cancelled, cancelled.testkit.do_not_process orders.status
enum<string> | null
Available options:
received, collecting_sample, sample_with_lab, completed, cancelled, failed orders.physician
object | null
orders.physician.first_name
string
requiredorders.physician.last_name
string
requiredorders.physician.npi
string
requiredorders.health_insurance_id
string | null
requiredVital ID of the health insurance.
orders.requisition_form_url
string | null
requiredDEPRECATED. Requistion form url.
orders.priority
boolean
default: falseDefines whether order is priority or not. For some labs, this refers to a STAT order.
orders.shipping_details
object | null
requiredShipping Details. For unregistered testkit orders.
orders.shipping_details.receiver_name
string
requiredorders.shipping_details.first_line
string
requiredorders.shipping_details.second_line
string | null
orders.shipping_details.city
string
requiredorders.shipping_details.state
string
requiredorders.shipping_details.zip
string
requiredorders.shipping_details.country
string
requiredorders.shipping_details.phone_number
string
requiredorders.activate_by
string | null
Schedule an Order to be processed in a future date.
orders.passthrough
string | null
total
integer | null
page
integer | null
size
integer | null