Lab Testing - At-home Phlebotomy
Get Phlebotomy Appointment
Get the appointment associated with an order.
GET
/
v3
/
order
/
{order_id}
/
phlebotomy
/
appointment
Authorization
Path
curl --request GET \
--url '{{BASE_URL}}/v3/order/413d7205-f8a9-42ed-aa4a-edb99e481ca0/phlebotomy/appointment' \
--header 'accept: application/json' \
--header 'x-vital-api-key: {YOUR_KEY}'
{
"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"
},
"location": {
"lng": -112.0772235,
"lat": 33.4421912
},
"start_at": "2023-05-17T20:00:00+00:00",
"end_at": "2023-05-17T22:00:00+00:00",
"iana_timezone": "America/Phoenix",
"type": "phlebotomy",
"provider": "getlabs",
"status": "pending",
"provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c",
"can_reschedule": true
}
Authorizations
x-vital-api-key
string
headerrequiredAPI key based authentication
Path Parameters
order_id
string
requiredYour Order ID.
Response
200 - application/json
address
object
requiredcan_reschedule
boolean
requiredend_at
string
requiredTime is in UTC
event_data
object
event_status
enum<string>
requiredAn enumeration.
Available options:
scheduled
, completed
, cancelled
, in_progress
events
object[]
requirediana_timezone
string
requiredid
string
requiredlocation
object
requiredorder_id
string
requiredprovider
enum<string>
requiredAn enumeration.
Available options:
getlabs
, axlehealth
provider_id
string
requiredstart_at
string
requiredTime is in UTC
status
enum<string>
requiredAn enumeration.
Available options:
confirmed
, pending
, in_progress
, completed
, cancelled
type
enum<string>
requiredAn enumeration.
Available options:
phlebotomy
user_id
string
requiredcurl --request GET \
--url '{{BASE_URL}}/v3/order/413d7205-f8a9-42ed-aa4a-edb99e481ca0/phlebotomy/appointment' \
--header 'accept: application/json' \
--header 'x-vital-api-key: {YOUR_KEY}'
{
"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"
},
"location": {
"lng": -112.0772235,
"lat": 33.4421912
},
"start_at": "2023-05-17T20:00:00+00:00",
"end_at": "2023-05-17T22:00:00+00:00",
"iana_timezone": "America/Phoenix",
"type": "phlebotomy",
"provider": "getlabs",
"status": "pending",
"provider_id": "e89eb489-7382-4966-bb14-7ab4763eba6c",
"can_reschedule": true
}