Skip to main content
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

​
x-vital-api-key
string
header
required

Vital Team API Key

Query Parameters

​
start_date
string<date> | null

Start date for appointment availability

Body

application/json

At-home phlebotomy appointment address.

​
first_line
string
required
​
city
string
required
​
state
string
required
​
zip_code
string
required
Pattern: ^\d{5}(-\d{4})?$
​
second_line
string | null
​
unit
string | null
deprecated

Deprecated. Use second_line instead to provide the unit number. Subject to removal after 20 Nov 2023.

​
access_notes
string | null
Maximum string length: 1000

Response

Successful Response

​
slots
DaySlots · object[]
required
​
timezone
string | null
Pattern: ^(?:(?:[A-Za-z_\-]+\/[A-Za-z_\-]+(?:\/[A-Za-z_\-]+)?)|(?:Etc\/[A-Za-z0-9+\-]+(?:\/[A-Za-z0-9]+)?|(?:CET|CST6CDT|EET|EST|EST5EDT|MET|MST|MST7MDT|PST8PDT|HST)))$