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 Shift Blocks
Retrieves a list of shift blocks configured in the system, including pagination details.
GET
/
shift-blocks
curl --request GET \
--url https://api.axlehealth.com/api/v2-stable/shift-blocks
{
"items": [
{
"shift_block_id": "e1a66d82-6b8c-4b65-8ae6-ffa3f8a4c08a",
"clinicians": [
{
"clinician_id": "b51c4e72-3c8f-47a1-bd4b-8fa3c78b9f95"
},
{
"clinician_id": "a19d2b7f-659f-42b4-b9a3-e72a7f7e8c2f"
}
],
"timezone": "America/New_York",
"start_datetime": "2024-07-01T08:00:00",
"end_datetime": "2024-07-01T17:00:00",
"recurrence": {
"rrule": "FREQ=MONTHLY;BYDAY=1MO;COUNT=6",
"exdate": [
"2024-09-02T00:00:00Z",
"2024-12-02T00:00:00Z"
]
},
"start_address": null,
"notes": "Weekly team meeting"
}
],
"pagination": {
"offset": 0,
"count_limit": 25,
"total_records": 1
}
}
Response
200 - application/json
A list of shift blocks
The response is of type object
.
curl --request GET \
--url https://api.axlehealth.com/api/v2-stable/shift-blocks
{
"items": [
{
"shift_block_id": "e1a66d82-6b8c-4b65-8ae6-ffa3f8a4c08a",
"clinicians": [
{
"clinician_id": "b51c4e72-3c8f-47a1-bd4b-8fa3c78b9f95"
},
{
"clinician_id": "a19d2b7f-659f-42b4-b9a3-e72a7f7e8c2f"
}
],
"timezone": "America/New_York",
"start_datetime": "2024-07-01T08:00:00",
"end_datetime": "2024-07-01T17:00:00",
"recurrence": {
"rrule": "FREQ=MONTHLY;BYDAY=1MO;COUNT=6",
"exdate": [
"2024-09-02T00:00:00Z",
"2024-12-02T00:00:00Z"
]
},
"start_address": null,
"notes": "Weekly team meeting"
}
],
"pagination": {
"offset": 0,
"count_limit": 25,
"total_records": 1
}
}
Assistant
Responses are generated using AI and may contain mistakes.