At-home Phlebotomy
Get Order Appointment Availability
- Home
- Wearables
- Lab Testing
- API Reference
- Event Catalog
- Changelog
Users
Debugging
Orders
At-home Phlebotomy
Tests
Results
Health Insurance
Sleep
Meal
Workouts
Profile
Activity
Body
Vitals
Body
Activity
Wellness
Nutrition
Team
Member
Invite
Org
Team API Keys
Team Custom Credentials
Team ETL Pipeline
Core
Lab Testing
Summary Data
Timeseries Data
Org Management
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
x-vital-api-key
string
*
x-vital-api-key
Required
string
API key based authentication
Address · object
*
Required
object
At-home phlebotomy appointment address.
first_line
First Line · string
*
first_line
Required
string
second_line
Second Line · string
second_line
string
city
City · string
*
city
Required
string
state
State · string
*
state
Required
string
zip_code
Zip Code · string
*
zip_code
Required
string
unit
Unit · string, deprecated
unit
Deprecated
string
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
},
...
],
},
]
}
Authorizations
x-vital-api-key
string
headerrequiredAPI key based authentication
Body
application/json
first_line
string
requiredsecond_line
string
city
string
requiredstate
string
requiredzip_code
string
requiredunit
string
deprecatedDeprecated. Use second_line
instead to provide the unit number. Subject to removal after 20 Nov 2023.
Response
200 - application/json
slots
object[]
requiredslots.date
string
requiredslots.slots
object[]
requiredslots.slots.booking_key
string
slots.slots.start
string
requiredTime is in UTC
slots.slots.end
string
requiredTime is in UTC
slots.slots.expires_at
string
slots.slots.price
number
requiredslots.slots.is_priority
boolean
requiredslots.slots.num_appointments_available
integer
requiredtimezone
string
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
},
...
],
},
]
}