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
Create Shift Block
Creates a shift block with the specified details and returns the unique identifier for the new shift block.
POST
/
shift-blocks
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/shift-blocks \
--header 'Content-Type: application/json' \
--data '{
"clinicians": [
{
"clinician_id": "bf8d6e7a-2c4b-4a6d-9e8c-f5d7e9c1a3b"
},
{
"clinician_id": "e2d5c7b9-1a4e-4c6b-9d8f-f5a6e8c9d1b3"
}
],
"timezone": "America/Phoenix",
"start_datetime": "2024-07-05T12:00:00",
"end_datetime": "2024-07-05T21:00:00",
"recurrence": {
"rrule": "FREQ=MONTHLY;BYDAY=2FR;INTERVAL=1;UNTIL=20240630T235959Z",
"exdate": [
"2024-08-09T00:00:00Z",
"2024-10-11T00:00:00Z"
]
},
"notes": "Bi-weekly sync"
}'
{
"shift_block_id": "8e2f0b38-144a-4589-ba14-fc5fc4329d63"
}
Body
application/json
Response
201
application/json
Shift block created successfully
The response is of type object
.
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/shift-blocks \
--header 'Content-Type: application/json' \
--data '{
"clinicians": [
{
"clinician_id": "bf8d6e7a-2c4b-4a6d-9e8c-f5d7e9c1a3b"
},
{
"clinician_id": "e2d5c7b9-1a4e-4c6b-9d8f-f5a6e8c9d1b3"
}
],
"timezone": "America/Phoenix",
"start_datetime": "2024-07-05T12:00:00",
"end_datetime": "2024-07-05T21:00:00",
"recurrence": {
"rrule": "FREQ=MONTHLY;BYDAY=2FR;INTERVAL=1;UNTIL=20240630T235959Z",
"exdate": [
"2024-08-09T00:00:00Z",
"2024-10-11T00:00:00Z"
]
},
"notes": "Bi-weekly sync"
}'
{
"shift_block_id": "8e2f0b38-144a-4589-ba14-fc5fc4329d63"
}
Assistant
Responses are generated using AI and may contain mistakes.