At-home Phlebotomy
Get Order Appointment Availability
Orders
At-home Phlebotomy
Patient Service Center (PSC)
Tests
Health Insurance
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
/
phlebotomy
/
appointment
/
availability
curl --request POST \
--url '{{BASE_URL}}/v3/order/phlebotomy/appointment/availability' \
--header 'accept: application/json' \
--header 'x-vital-api-key: {YOUR_KEY}' \
--data '
{
"first_line": "256 West Lincoln Street",
"second_line": "14",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004",
}
'
{
"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
},
...
],
},
]
}
curl --request POST \
--url '{{BASE_URL}}/v3/order/phlebotomy/appointment/availability' \
--header 'accept: application/json' \
--header 'x-vital-api-key: {YOUR_KEY}' \
--data '
{
"first_line": "256 West Lincoln Street",
"second_line": "14",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004",
}
'
{
"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
},
...
],
},
]
}
Authorizations
Vital Team API Key
Query Parameters
Start date for appointment availability
Body
application/json
At-home phlebotomy appointment address.
Deprecated. Use second_line
instead to provide the unit number. Subject to removal after 20 Nov 2023.
Response
200
application/json
Successful Response
Time is in UTC
Time is in UTC
Deprecated. Use second_line
instead to provide the unit number. Subject to removal after 20 Nov 2023.
curl --request POST \
--url '{{BASE_URL}}/v3/order/phlebotomy/appointment/availability' \
--header 'accept: application/json' \
--header 'x-vital-api-key: {YOUR_KEY}' \
--data '
{
"first_line": "256 West Lincoln Street",
"second_line": "14",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004",
}
'
{
"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
},
...
],
},
]
}