Create appointment availability

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

POST /v3/order/phlebotomy/appointment/availability

cURL

curl --request POST \
     --url '{{BASE_URL}}/v3/order/phlebotomy/appointment/availability' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: YOUR_API_KEY' \
     --data '
{
    "first_line": "256 West Lincoln Street",
    "second_line": "14",
    "city": "Phoenix",
    "state": "AZ",
    "zip_code": "85004"
}
'

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.lab_tests.get_phlebotomy_appointment_availability(
    first_line="123 Main St",
    city="San Francisco",
    state="CA",
    zip_code="94105",
)

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.labTests.getPhlebotomyAppointmentAvailability({
    body: {
        firstLine: "123 Main St",
        city: "San Francisco",
        state: "CA",
        zipCode: "94105",
    },
});

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.types.UsAddress;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.labTests().getPhlebotomyAppointmentAvailability(
    UsAddress.builder()
        .firstLine("123 Main St")
        .city("San Francisco")
        .state("CA")
        .zipCode("94105")
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

response, err := c.LabTests.GetPhlebotomyAppointmentAvailability(context.TODO(), &junction.GetPhlebotomyAppointmentAvailabilityLabTestsRequest{
    Body: &junction.UsAddress{
        FirstLine: "123 Main St",
        City:      "San Francisco",
        State:     "CA",
        ZipCode:   "94105",
    },
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Response

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

curl --request POST \
     --url '{{BASE_URL}}/v3/order/phlebotomy/appointment/availability' \
     --header 'accept: application/json' \
     --header 'x-vital-api-key: YOUR_API_KEY' \
     --data '
{
    "first_line": "256 West Lincoln Street",
    "second_line": "14",
    "city": "Phoenix",
    "state": "AZ",
    "zip_code": "85004"
}
'

from junction import Junction
from junction.environment import JunctionEnvironment

client = Junction(
    api_key="YOUR_API_KEY",
    environment=JunctionEnvironment.SANDBOX,
)

data = client.lab_tests.get_phlebotomy_appointment_availability(
    first_line="123 Main St",
    city="San Francisco",
    state="CA",
    zip_code="94105",
)

import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";

const client = new JunctionClient({
    apiKey: "YOUR_API_KEY",
    environment: JunctionEnvironment.Sandbox,
});

const data = await client.labTests.getPhlebotomyAppointmentAvailability({
    body: {
        firstLine: "123 Main St",
        city: "San Francisco",
        state: "CA",
        zipCode: "94105",
    },
});

import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.types.UsAddress;

Junction client = Junction.builder()
    .apiKey("YOUR_API_KEY")
    .environment(Environment.SANDBOX)
    .build();

var data = client.labTests().getPhlebotomyAppointmentAvailability(
    UsAddress.builder()
        .firstLine("123 Main St")
        .city("San Francisco")
        .state("CA")
        .zipCode("94105")
        .build()
);

import (
    "context"

    junction "github.com/junction-api/junction-go"
    "github.com/junction-api/junction-go/client"
    "github.com/junction-api/junction-go/option"
)

c := client.NewClient(
    option.WithApiKey("YOUR_API_KEY"),
    option.WithBaseURL(junction.Environments.Sandbox),
)

response, err := c.LabTests.GetPhlebotomyAppointmentAvailability(context.TODO(), &junction.GetPhlebotomyAppointmentAvailabilityLabTestsRequest{
    Body: &junction.UsAddress{
        FirstLine: "123 Main St",
        City:      "San Francisco",
        State:     "CA",
        ZipCode:   "94105",
    },
})
if err != nil {
    return err
}
fmt.Printf("Received data %s\n", response)

Response

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

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