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
List Territories
For get information about a territories’ zip codes, use the Get Territory endpoint.
GET
/
territories
curl --request GET \
--url https://api.axlehealth.com/api/v2-stable/territories
{
"items": [
{
"territory_id": "b84b4c6a-2e5f-8d1a-9c0b-3e4f5a6b7c8d",
"name": "NY -- Manhattan",
"metadata": {
"region": "Northeast",
"population": "1,628,706",
"area_sqm": "87.5"
}
}
],
"pagination": {
"offset": 0,
"count_limit": 25,
"total_records": 100
}
}
Query Parameters
The number of records to skip.
The maximum number of records to return.
Response
200 - application/json
A list of territories
The response is of type object
.
curl --request GET \
--url https://api.axlehealth.com/api/v2-stable/territories
{
"items": [
{
"territory_id": "b84b4c6a-2e5f-8d1a-9c0b-3e4f5a6b7c8d",
"name": "NY -- Manhattan",
"metadata": {
"region": "Northeast",
"population": "1,628,706",
"area_sqm": "87.5"
}
}
],
"pagination": {
"offset": 0,
"count_limit": 25,
"total_records": 100
}
}
Assistant
Responses are generated using AI and may contain mistakes.