curl --request POST \
--url '{{BASE_URL}}/v3/order/413d7205-f8a9-42ed-aa4a-edb99e481ca0/phlebotomy/appointment/request' \
--header 'accept: application/json' \
--header 'x-vital-api-key: YOUR_API_KEY' \
--data '
{
"address":
{
"first_line": "256 West Lincoln Street",
"second_line": "14",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004"
},
"provider": "phlebfinders",
"appointment_notes": "Please bring photo ID"
}
'
from junction import AppointmentProvider, Junction, UsAddress
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.lab_tests.request_phlebotomy_appointment(
"<order_id>",
address=UsAddress(
first_line="123 Main St",
city="San Francisco",
state="CA",
zip_code="94105",
),
provider=AppointmentProvider.PHLEBFINDERS,
)
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.labTests.requestPhlebotomyAppointment({
orderId: "<order_id>",
address: {
firstLine: "123 Main St",
city: "San Francisco",
state: "CA",
zipCode: "94105",
},
provider: "phlebfinders",
});
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.labtests.requests.RequestAppointmentRequest;
import com.junction.api.types.AppointmentProvider;
import com.junction.api.types.UsAddress;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.labTests().requestPhlebotomyAppointment(
"<order_id>",
RequestAppointmentRequest.builder()
.address(
UsAddress.builder()
.firstLine("123 Main St")
.city("San Francisco")
.state("CA")
.zipCode("94105")
.build()
)
.provider(AppointmentProvider.PHLEBFINDERS)
.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.RequestPhlebotomyAppointment(context.TODO(), &junction.RequestAppointmentRequest{
OrderId: "<order_id>",
Address: &junction.UsAddress{
FirstLine: "123 Main St",
City: "San Francisco",
State: "CA",
ZipCode: "94105",
},
Provider: junction.AppointmentProviderPhlebfinders,
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0",
"user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227",
"address": {
"first_line": "West Lincoln Street",
"second_line": "",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004",
"unit": "14",
"access_notes": "Gate code #1234, use side entrance"
},
"location": {
"lng": -112.0772235,
"lat": 33.4421912
},
"type": "phlebotomy",
"provider": "phlebfinders",
"status": "pending",
"provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c",
"can_reschedule":false,
"appointment_notes": "Please bring photo ID"
}
At-home Phlebotomy
Create appointment request
Create or submit order phlebotomy appointment request via the Junction API. Requires authentication with your team API key.
POST
/
v3
/
order
/
{order_id}
/
phlebotomy
/
appointment
/
request
curl --request POST \
--url '{{BASE_URL}}/v3/order/413d7205-f8a9-42ed-aa4a-edb99e481ca0/phlebotomy/appointment/request' \
--header 'accept: application/json' \
--header 'x-vital-api-key: YOUR_API_KEY' \
--data '
{
"address":
{
"first_line": "256 West Lincoln Street",
"second_line": "14",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004"
},
"provider": "phlebfinders",
"appointment_notes": "Please bring photo ID"
}
'
from junction import AppointmentProvider, Junction, UsAddress
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.lab_tests.request_phlebotomy_appointment(
"<order_id>",
address=UsAddress(
first_line="123 Main St",
city="San Francisco",
state="CA",
zip_code="94105",
),
provider=AppointmentProvider.PHLEBFINDERS,
)
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.labTests.requestPhlebotomyAppointment({
orderId: "<order_id>",
address: {
firstLine: "123 Main St",
city: "San Francisco",
state: "CA",
zipCode: "94105",
},
provider: "phlebfinders",
});
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.labtests.requests.RequestAppointmentRequest;
import com.junction.api.types.AppointmentProvider;
import com.junction.api.types.UsAddress;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.labTests().requestPhlebotomyAppointment(
"<order_id>",
RequestAppointmentRequest.builder()
.address(
UsAddress.builder()
.firstLine("123 Main St")
.city("San Francisco")
.state("CA")
.zipCode("94105")
.build()
)
.provider(AppointmentProvider.PHLEBFINDERS)
.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.RequestPhlebotomyAppointment(context.TODO(), &junction.RequestAppointmentRequest{
OrderId: "<order_id>",
Address: &junction.UsAddress{
FirstLine: "123 Main St",
City: "San Francisco",
State: "CA",
ZipCode: "94105",
},
Provider: junction.AppointmentProviderPhlebfinders,
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0",
"user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227",
"address": {
"first_line": "West Lincoln Street",
"second_line": "",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004",
"unit": "14",
"access_notes": "Gate code #1234, use side entrance"
},
"location": {
"lng": -112.0772235,
"lat": 33.4421912
},
"type": "phlebotomy",
"provider": "phlebfinders",
"status": "pending",
"provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c",
"can_reschedule":false,
"appointment_notes": "Please bring photo ID"
}
curl --request POST \
--url '{{BASE_URL}}/v3/order/413d7205-f8a9-42ed-aa4a-edb99e481ca0/phlebotomy/appointment/request' \
--header 'accept: application/json' \
--header 'x-vital-api-key: YOUR_API_KEY' \
--data '
{
"address":
{
"first_line": "256 West Lincoln Street",
"second_line": "14",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004"
},
"provider": "phlebfinders",
"appointment_notes": "Please bring photo ID"
}
'
from junction import AppointmentProvider, Junction, UsAddress
from junction.environment import JunctionEnvironment
client = Junction(
api_key="YOUR_API_KEY",
environment=JunctionEnvironment.SANDBOX,
)
data = client.lab_tests.request_phlebotomy_appointment(
"<order_id>",
address=UsAddress(
first_line="123 Main St",
city="San Francisco",
state="CA",
zip_code="94105",
),
provider=AppointmentProvider.PHLEBFINDERS,
)
import { JunctionClient, JunctionEnvironment } from "@junction-api/sdk";
const client = new JunctionClient({
apiKey: "YOUR_API_KEY",
environment: JunctionEnvironment.Sandbox,
});
const data = await client.labTests.requestPhlebotomyAppointment({
orderId: "<order_id>",
address: {
firstLine: "123 Main St",
city: "San Francisco",
state: "CA",
zipCode: "94105",
},
provider: "phlebfinders",
});
import com.junction.api.Junction;
import com.junction.api.core.Environment;
import com.junction.api.resources.labtests.requests.RequestAppointmentRequest;
import com.junction.api.types.AppointmentProvider;
import com.junction.api.types.UsAddress;
Junction client = Junction.builder()
.apiKey("YOUR_API_KEY")
.environment(Environment.SANDBOX)
.build();
var data = client.labTests().requestPhlebotomyAppointment(
"<order_id>",
RequestAppointmentRequest.builder()
.address(
UsAddress.builder()
.firstLine("123 Main St")
.city("San Francisco")
.state("CA")
.zipCode("94105")
.build()
)
.provider(AppointmentProvider.PHLEBFINDERS)
.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.RequestPhlebotomyAppointment(context.TODO(), &junction.RequestAppointmentRequest{
OrderId: "<order_id>",
Address: &junction.UsAddress{
FirstLine: "123 Main St",
City: "San Francisco",
State: "CA",
ZipCode: "94105",
},
Provider: junction.AppointmentProviderPhlebfinders,
})
if err != nil {
return err
}
fmt.Printf("Received data %s\n", response)
{
"id": "413d7205-f8a9-42ed-aa4a-edb99e481ca0",
"user_id": "202b2c2f-fb4c-44dc-a4f8-621186fde227",
"address": {
"first_line": "West Lincoln Street",
"second_line": "",
"city": "Phoenix",
"state": "AZ",
"zip_code": "85004",
"unit": "14",
"access_notes": "Gate code #1234, use side entrance"
},
"location": {
"lng": -112.0772235,
"lat": 33.4421912
},
"type": "phlebotomy",
"provider": "phlebfinders",
"status": "pending",
"provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c",
"can_reschedule":false,
"appointment_notes": "Please bring photo ID"
}
Authorizations
Vital Team API Key
Path Parameters
Your Order ID.
Body
application/json
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Time is in UTC
Time is in UTC
ℹ️ This enum is non-exhaustive.
Available options:
phlebotomy, patient_service_center ℹ️ This enum is non-exhaustive.
Available options:
getlabs, phlebfinders, quest, sonora_quest ℹ️ This enum is non-exhaustive.
Available options:
confirmed, pending, reserved, in_progress, completed, cancelled ℹ️ This enum is non-exhaustive.
Available options:
pending, reserved, scheduled, completed, cancelled, in_progress Show child attributes
Show child attributes
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)))$Maximum string length:
1000Was this page helpful?