Body
application/json
Response
Successful response
The response is of type object
.
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/coverage-lookup \
--header 'Content-Type: application/json' \
--data '{
"address": {
"line1": "123 Main St",
"line2": "",
"city": "Anytown",
"state": "CA",
"zipcode": "12345"
},
"zipcode": "12345",
"clinic_id": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
}'
{
"service_areas": [
{
"service_area_id": "8a10287f-02f4-438b-af59-b83381dd4fdb",
"name": "Los Angeles West",
"services": [
{
"service_id": "82078655-7d02-46e7-bf3a-0965d5df4b5e",
"name": "Blood Test",
"description": "",
"duration_minutes": 30
}
],
"service_bundles": [
{
"service_bundle_id": "7360cc45-3178-4b45-831f-823ab721a582",
"name": "Annual Exam",
"description": "Combines in-person RN conducting blood draw with virtual MD asking questions."
}
]
}
]
}
Lists all the Service Areas that cover a given address, zip code, or Clinic, and return the associated Services and Service Bundles.
You can use this endpoint to check if a service is bookable at a certain address.
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/coverage-lookup \
--header 'Content-Type: application/json' \
--data '{
"address": {
"line1": "123 Main St",
"line2": "",
"city": "Anytown",
"state": "CA",
"zipcode": "12345"
},
"zipcode": "12345",
"clinic_id": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
}'
{
"service_areas": [
{
"service_area_id": "8a10287f-02f4-438b-af59-b83381dd4fdb",
"name": "Los Angeles West",
"services": [
{
"service_id": "82078655-7d02-46e7-bf3a-0965d5df4b5e",
"name": "Blood Test",
"description": "",
"duration_minutes": 30
}
],
"service_bundles": [
{
"service_bundle_id": "7360cc45-3178-4b45-831f-823ab721a582",
"name": "Annual Exam",
"description": "Combines in-person RN conducting blood draw with virtual MD asking questions."
}
]
}
]
}
Successful response
The response is of type object
.