Query Parameters
The starting point for the list of shifts (for pagination).
Example:
0
The maximum number of shifts to return.
Example:
100
Response
200 - application/json
List Shifts
The response is of type object
.
curl --request GET \
--url https://api.axlehealth.com/api/v2-stable/shifts
{
"items": [
{
"shift_id": "f61e8d80-92f7-42a8-b4c7-ff118bb4cde6",
"clinician_id": "7d8e9f1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
"time_zone": "America/Los_Angeles",
"start_datetime": "2023-06-02 08:00:00-0700",
"end_datetime": "2023-06-02 16:00:00-0700",
"rrule": "",
"exclude_datetimes": [],
"mobile_territories": [
{
"territory_id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"virtual_territories": [],
"clinic_ids": [],
"notes": "We may change the clinician on this one."
}
],
"pagination": {
"offset": 0,
"count_limit": 25,
"total_records": 1
}
}
Retrieves a list of all shifts configured in your account.
curl --request GET \
--url https://api.axlehealth.com/api/v2-stable/shifts
{
"items": [
{
"shift_id": "f61e8d80-92f7-42a8-b4c7-ff118bb4cde6",
"clinician_id": "7d8e9f1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
"time_zone": "America/Los_Angeles",
"start_datetime": "2023-06-02 08:00:00-0700",
"end_datetime": "2023-06-02 16:00:00-0700",
"rrule": "",
"exclude_datetimes": [],
"mobile_territories": [
{
"territory_id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"virtual_territories": [],
"clinic_ids": [],
"notes": "We may change the clinician on this one."
}
],
"pagination": {
"offset": 0,
"count_limit": 25,
"total_records": 1
}
}
The starting point for the list of shifts (for pagination).
0
The maximum number of shifts to return.
100
List Shifts
The response is of type object
.