Lab Testing - At-home Phlebotomy
Get Order Appointment Availability
Lab Testing - At-home Phlebotomy
Get Order Appointment Availability
Return the available time slots to book an appointment with a phlebotomist
for the given address and order.
POST
/v3/order/{order_id}/phlebotomy/appointment/availability
x-vital-api-key*
curl --request POST \
--url https://api.tryvital.io/v3/order/{order_id}/phlebotomy/appointment/availability \
--header 'x-vital-api-key: <x-vital-api-key>' \
--data '{
"city": "<city>",
"first_line": "<first_line>",
"state": "<state>",
"zip_code": "<zip_code>"
}'
curl --request POST \
--url '{{BASE_URL}}/v3/order/413d7205-f8a9-42ed-aa4a-edb99e481ca0/phlebotomy/appointment/availability' \
--header 'accept: application/json' \
--header 'x-vital-api-key: {YOUR_KEY}' \
--data '
{
"first_line": "West Lincoln Street",
"second_line": "",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004",
"unit": "14",
}
'
{
"timezone":"America/Phoenix",
"slots": [
{
"date":"2023-05-09",
"slots": [
{
"booking_key": "foo123",
"start": "2023-05-09T17:00:00+00:00",
"end": "2023-05-09T19:00:00+00:00",
"expires_at": "2023-05-09T12:39:57.827000+00:00",
"price": 3500,
"is_priority": true,
"num_appointments_available": 5
},
...
],
},
{
"date":"2023-05-10",
"slots": [
{
"booking_key": "bar456",
"start": "2023-05-10T12:00:00+00:00",
"end": "2023-05-10T14:00:00+00:00",
"expires_at": "2023-05-09T12:39:57.852000+00:00",
"price": 7900,
"is_priority": true,
"num_appointments_available": 5
},
...
],
},
]
}
​Path Parameters
order_idrequired
string
Your Order ID.
​Body
cityrequired
string
City
first_linerequired
string
First Line
second_line
string
Second Line
staterequired
string
State
unit
string
Unit
zip_coderequired
string
Zip Code
​Response
slotsrequired
array
timezone
string
Timezone
curl --request POST \
--url '{{BASE_URL}}/v3/order/413d7205-f8a9-42ed-aa4a-edb99e481ca0/phlebotomy/appointment/availability' \
--header 'accept: application/json' \
--header 'x-vital-api-key: {YOUR_KEY}' \
--data '
{
"first_line": "West Lincoln Street",
"second_line": "",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004",
"unit": "14",
}
'
{
"timezone":"America/Phoenix",
"slots": [
{
"date":"2023-05-09",
"slots": [
{
"booking_key": "foo123",
"start": "2023-05-09T17:00:00+00:00",
"end": "2023-05-09T19:00:00+00:00",
"expires_at": "2023-05-09T12:39:57.827000+00:00",
"price": 3500,
"is_priority": true,
"num_appointments_available": 5
},
...
],
},
{
"date":"2023-05-10",
"slots": [
{
"booking_key": "bar456",
"start": "2023-05-10T12:00:00+00:00",
"end": "2023-05-10T14:00:00+00:00",
"expires_at": "2023-05-09T12:39:57.852000+00:00",
"price": 7900,
"is_priority": true,
"num_appointments_available": 5
},
...
],
},
]
}