Skip to main content
GET
/
v3
/
orders
curl --request GET \
     --url '{{BASE_URL}}/v3/orders' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}'
'

{
  "orders": [
    {
      "id": "0ee312e2-6773-4a21-a6e1-506882cd98ed",
      "team_id": "cbb64555-af07-46c1-be09-ef89308e9b60",
      "user_id": "94e2d9f2-d600-4a23-9f08-536df378e2c7",
      "patient_details": {
        "dob": "2020-01-01",
        "gender": "male"
      },
      "priority": false,
      "patient_address": {
        "receiver_name": "John Doe",
        "first_line": "123 Main St.",
        "second_line": "Apt. 208",
        "city": "San Francisco",
        "state": "CA",
        "zip": "91189",
        "country": "United States",
        "phone_number": "+1123456789"
      },
      "details": {
        "type": "testkit",
        "data": {
          "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
          "shipment": {
            "id": "d55210cc-3d9f-4115-8262-5013f700c7be",
            "outbound_tracking_number": "<outbound_tracking_number>",
            "outbound_tracking_url": "<outbound_tracking_url>",
            "inbound_tracking_number": "<inbound_tracking_number>",
            "inbound_tracking_url": "<inbound_tracking_url>",
            "outbound_courier": "usps",
            "inbound_courier": "usps",
            "notes": "<notes>",
            "created_at": "2020-01-01T00:00:00.000Z",
            "updated_at": "2020-01-01T00:00:00.000Z"
          },
          "created_at": "2020-01-01T00:00:00Z",
          "updated_at": "2020-01-01T00:00:00Z"
        }
      },
      "lab_test": {
        "name": "Lipids Panel",
        "description": "Cholesterol test",
        "method": "testkit"
      },
      "sample_id": "123456789",
      "notes": "This is a note",
      "created_at": "2020-01-01T00:00:00Z",
      "updated_at": "2020-01-01T00:00:00Z",
      "status": "collecting_sample",
      "events": [
        {
          "id": 1,
          "created_at": "2022-01-01T00:00:00Z",
          "status": "received.testkit.ordered"
        },
        {
          "id": 2,
          "created_at": "2022-01-02T00:00:00Z",
          "status": "received.testkit.requisition_created"
        },
        {
          "id": 3,
          "created_at": "2022-01-03T00:00:00Z",
          "status": "collecting_sample.testkit.transit_customer"
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "size": 50
}

curl --request GET \
     --url '{{BASE_URL}}/v3/orders' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}'
'

{
  "orders": [
    {
      "id": "0ee312e2-6773-4a21-a6e1-506882cd98ed",
      "team_id": "cbb64555-af07-46c1-be09-ef89308e9b60",
      "user_id": "94e2d9f2-d600-4a23-9f08-536df378e2c7",
      "patient_details": {
        "dob": "2020-01-01",
        "gender": "male"
      },
      "priority": false,
      "patient_address": {
        "receiver_name": "John Doe",
        "first_line": "123 Main St.",
        "second_line": "Apt. 208",
        "city": "San Francisco",
        "state": "CA",
        "zip": "91189",
        "country": "United States",
        "phone_number": "+1123456789"
      },
      "details": {
        "type": "testkit",
        "data": {
          "id": "a655f0e4-6405-4a1d-80b7-66f06c2108a7",
          "shipment": {
            "id": "d55210cc-3d9f-4115-8262-5013f700c7be",
            "outbound_tracking_number": "<outbound_tracking_number>",
            "outbound_tracking_url": "<outbound_tracking_url>",
            "inbound_tracking_number": "<inbound_tracking_number>",
            "inbound_tracking_url": "<inbound_tracking_url>",
            "outbound_courier": "usps",
            "inbound_courier": "usps",
            "notes": "<notes>",
            "created_at": "2020-01-01T00:00:00.000Z",
            "updated_at": "2020-01-01T00:00:00.000Z"
          },
          "created_at": "2020-01-01T00:00:00Z",
          "updated_at": "2020-01-01T00:00:00Z"
        }
      },
      "lab_test": {
        "name": "Lipids Panel",
        "description": "Cholesterol test",
        "method": "testkit"
      },
      "sample_id": "123456789",
      "notes": "This is a note",
      "created_at": "2020-01-01T00:00:00Z",
      "updated_at": "2020-01-01T00:00:00Z",
      "status": "collecting_sample",
      "events": [
        {
          "id": 1,
          "created_at": "2022-01-01T00:00:00Z",
          "status": "received.testkit.ordered"
        },
        {
          "id": 2,
          "created_at": "2022-01-02T00:00:00Z",
          "status": "received.testkit.requisition_created"
        },
        {
          "id": 3,
          "created_at": "2022-01-03T00:00:00Z",
          "status": "collecting_sample.testkit.transit_customer"
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "size": 50
}

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
​
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.

​
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