PSC Appointment Availability

Create or submit order psc appointment availability via the Junction API. Requires authentication with your team API key.

POST /v3/order/psc/appointment/availability

cURL

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"
}
'

Response

{
    "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

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"
}
'

Response

{
    "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, sonora_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

Pattern: ^\d{5}$

radius · enum<string> | null · default: 25

Radius in which to search in miles ℹ️ 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

200

application/json

Successful Response

slots · DaySlots · object[] · required

Show child attributes

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)))$