Skip to main content
GET

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

status
enum<string>[] | null

Filter by low level status.

ℹ️ This enum is non-exhaustive.

Available options:
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,
redraw_available,
corrected,
lab_processing_blocked
order_key
enum<string> | null

Order key to sort by.

Available options:
created_at,
patient_name,
last_status
order_direction
enum<string> | null

Order direction to sort by.

Available options:
asc,
desc
order_type
enum<string>[] | null

Filter by method used to perform the lab test.

The method used to perform a lab test. ℹ️ This enum is non-exhaustive.

Available options:
testkit,
walk_in_test,
at_home_phlebotomy,
on_site_collection
is_critical
boolean | null

Filter by critical order status.

interpretation
enum<string> | null

Filter by result interpretation of the lab test. ℹ️ This enum is non-exhaustive.

Available options:
normal,
abnormal,
critical,
unknown
order_activation_types
enum<string>[] | null

Filter by activation type.

ℹ️ This enum is non-exhaustive.

Available options:
current,
scheduled
user_id
string<uuid> | 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<uuid>[] | null

Filter by order ids.

order_transaction_id
string<uuid> | null

Filter by order transaction ID

page
integer
default:1
Required range: x >= 1
size
integer
default:50
Required range: 1 <= x <= 100

Response

Successful Response

orders
ClientFacingOrder · object[]
required
total
integer | null
page
integer | null
size
integer | null