Get Orders
GET many orders with filters.
Authorizations
Vital Team API Key
Query Parameters
Search by order id, user id, patient name, shipping dob, or shipping recipient name.
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
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
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
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
Filter by low level status.
ℹ️ This enum is non-exhaustive.
ordered
, requisition_created
, requisition_bypassed
, transit_customer
, out_for_delivery
, with_customer
, transit_lab
, delivered_to_lab
, completed
, failure_to_deliver_to_lab
, failure_to_deliver_to_customer
, problem_in_transit_lab
, problem_in_transit_customer
, sample_error
, appointment_scheduled
, appointment_cancelled
, appointment_pending
, draw_completed
, cancelled
, lost
, do_not_process
, partial_results
, awaiting_registration
, registered
Order key to sort by.
created_at
, patient_name
, last_status
Order direction to sort by.
asc
, desc
Filter by method used to perform the lab test.
The method used to perform a lab test. ℹ️ This enum is non-exhaustive.
testkit
, walk_in_test
, at_home_phlebotomy
Filter by critical order status.
Filter by activation type.
ℹ️ This enum is non-exhaustive.
current
, scheduled
Filter by user ID.
Filter by patient name.
Filter by shipping recipient name.
Filter by order ids.
x >= 1
1 <= x <= 100
Response
The response is of type object
.