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
Allows the creation of a new shift for a specified clinician.
POST
/
shifts
Copy
Ask AI
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/shifts \
--header 'Content-Type: application/json' \
--data '{
"clinician_id": "7d8e9f1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
"timezone": "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_territory_ids": [
{
"territory_id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"virtual_territory_ids": [],
"clinic_ids": [],
"notes": "We may change the clinician on this one."
}'
Copy
Ask AI
{
"shift_id": "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f"
}
Body
application/json
Response
200 - application/json
Shift created successfully
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://api.axlehealth.com/api/v2-stable/shifts \
--header 'Content-Type: application/json' \
--data '{
"clinician_id": "7d8e9f1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b",
"timezone": "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_territory_ids": [
{
"territory_id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"virtual_territory_ids": [],
"clinic_ids": [],
"notes": "We may change the clinician on this one."
}'
Copy
Ask AI
{
"shift_id": "3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f"
}
Assistant
Responses are generated using AI and may contain mistakes.