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
}
}
Retrieves a list of shift blocks configured in the system, including pagination details.
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
}
}
A list of shift blocks
The response is of type object
.