API Documentation
API Reference
- POSTCoverage Lookup
- POSTGenerate potential visit from service bundle
- POSTVisit time options for existing visit
- POSTVisit time options for potential visit
- POSTClinician options for existing visit at existing time
- POSTClinician options for potential visit over date range
- POSTClinician Options for Potential Visit at Proposed Time
- POSTCreate Visit
- GETGet Visit
- PATCHEdit Visit
- POSTCreate Visit Request
- GETGet Visit Request
- PATCHEdit Visit Request
- POSTCreate Patient
- GETGet Patient
- PATCHEdit Patient
- GETList Services
- GETList Service Bundles
- POSTCreate Clinician
- GETGet Clinician
- PATCHEdit Clinician
- GETList Clinicians
- POSTCreate Shift
- GETList all shifts
- GETGet Shift
- PATCHEdit Shift
- POSTCreate Shift Block
- GETList Shift Blocks
- GETGet Shift Block
- PATCHEdit Shift Block
- DELDelete Shift Block
- POSTCreate Territory
- GETList Territories
- PATCHEdit Territory
- GETGet Territory
- POSTCreate Qualification
- GETList Qualifications
- GETGet Qualification
- PATCHEdit Qualification
- DELDelete Qualification
- GETList Payers
- POSTCreate Care Team
- GETList Care Teams
- GETGet Care Team
- PATCHEdit Care Team
- POSTGenerate download link for document
- POSTCreate Visit Reservation
- DELDelete Reservation
API Reference
Coverage Lookup
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.
When creating a visit, remember that you won’t be able to mix and match services between service areas.
POST
/
coverage-lookup
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."
}
]
}
]
}
Body
application/json
Response
200
application/json
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."
}
]
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.