Skip to main content
POST
/
v3
/
order
/
psc
/
appointment
/
availability
curl --request POST \
     --url '{{BASE_URL}}/v3/order/psc/appointment/availability' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}' \
     --data '
{
    "lab": "quest",
    "zip_code": "85004",
    "radius": "25",
}
'

{
    "slots": [
        {
            "location": {
                "location": {
                    "lng": -112.0568538,
                    "lat": 33.4631386
                },
                "address": {
                    "first_line": "1300 N 12th St",
                    "second_line": "Ste 300",
                    "city": "Phoenix",
                    "state": "AZ",
                    "zip_code": "85006",
                },
                "code": "23070",
                "name": "QUEST",
                "iana_timezone": "America/Los_Angeles"
            },
            "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": 0.0,
                    "is_priority": true,
                    "num_appointments_available": 1
                },
                ...
            ],
        },
        {
            "location": {
                "location": {
                    "lng": -112.0568538,
                    "lat": 33.4631386
                },
                "address": {
                    "first_line": "1300 N 12th St",
                    "second_line": "Ste 300",
                    "city": "Phoenix",
                    "state": "AZ",
                    "zip_code": "85006",
                },
                "code": "23070",
                "name": "QUEST"
            },
            "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": 0.0,
                    "is_priority": true,
                    "num_appointments_available": 1
                },
                ...
            ],
        },
    ],
    "timezone": null
}
Use the allow_stale parameter for faster responses via the Availability Cache. This feature is currently in closed beta. See PSC Appointment Scheduling for more info.
curl --request POST \
     --url '{{BASE_URL}}/v3/order/psc/appointment/availability' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: {YOUR_KEY}' \
     --data '
{
    "lab": "quest",
    "zip_code": "85004",
    "radius": "25",
}
'

{
    "slots": [
        {
            "location": {
                "location": {
                    "lng": -112.0568538,
                    "lat": 33.4631386
                },
                "address": {
                    "first_line": "1300 N 12th St",
                    "second_line": "Ste 300",
                    "city": "Phoenix",
                    "state": "AZ",
                    "zip_code": "85006",
                },
                "code": "23070",
                "name": "QUEST",
                "iana_timezone": "America/Los_Angeles"
            },
            "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": 0.0,
                    "is_priority": true,
                    "num_appointments_available": 1
                },
                ...
            ],
        },
        {
            "location": {
                "location": {
                    "lng": -112.0568538,
                    "lat": 33.4631386
                },
                "address": {
                    "first_line": "1300 N 12th St",
                    "second_line": "Ste 300",
                    "city": "Phoenix",
                    "state": "AZ",
                    "zip_code": "85006",
                },
                "code": "23070",
                "name": "QUEST"
            },
            "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": 0.0,
                    "is_priority": true,
                    "num_appointments_available": 1
                },
                ...
            ],
        },
    ],
    "timezone": null
}

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Query Parameters

​
lab
enum<string>
required

Lab to check for availability

Available options:
quest
​
start_date
string<date> | null

Start date for appointment availability

​
site_codes
string[] | null

List of site codes to fetch availability for

​
zip_code
string | null

Zip code of the area to check

​
radius
enum<string> | null
default:25

Radius in which to search. (meters) ℹ️ This enum is non-exhaustive.

Available options:
10,
20,
25,
50,
100
​
allow_stale
boolean
default:false

If true, allows cached availability data to be returned.

Response

Successful Response

​
slots
DaySlots · object[]
required
​
timezone
string | null