Getting Started
API
- POSTCancel Appointment
- GETCheck If Patient With Appointments
- GETCheck Phone Blacklist Status
- PUTConnect Record To Event
- POSTCreate Appointment
- POSTCreate Event
- DELDelete Event
- DELDelete Recurring Event
- DELDelete Shifts By Dates
- DELDelete Shifts By Provider
- POSTExecute Extend Recurring
- GETGet Appointment Forms
- GETGet Appointment Forms With Status
- GETGet Availability
- GETGet Bookable Usage
- GETGet Conflicted Shifts
- GETGet Event Appointment Checklist
- GETGet Event Detail
- GETGet Event Logs
- GETGet Event Message Types
- GETGet Event Messages
- GETGet Events For Patient
- GETGet Front Page
- GETGet Locations
- POSTGet Or Create Patient
- GETGet Shifts By Date
- GETList Events
- POSTUpdate Appointment Checklist
- PUTUpdate Event
- PUTUpdate Event Status
- POST
Tenant
Get Shifts By Date
Copy
curl --request GET \
--url https://api.decodahealth.com/calendar/shifts/by-date \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'Copy
{
"date": "<string>",
"providers": [
{
"provider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
},
"shifts": [
{
"id": "<string>",
"title": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"type": "APPOINTMENT",
"status": "PENDING",
"location": {
"id": "<string>",
"isVirtual": true
},
"attendees": [],
"recurringEventId": "<string>",
"recurringEvent": {
"id": "<string>",
"rrule": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"durationMinutes": 123,
"timezone": "<string>",
"type": "APPOINTMENT",
"title": "<string>",
"organizerId": "<string>",
"serviceIds": [
"<string>"
],
"capacity": 123,
"attendeeIds": [
"<string>"
],
"locationId": "<string>"
},
"eventServices": [],
"icons": [],
"capacity": 123
}
],
"appointments": [
{
"id": "<string>",
"title": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"type": "APPOINTMENT",
"status": "PENDING",
"location": {
"id": "<string>",
"isVirtual": true
},
"attendees": [],
"recurringEventId": "<string>",
"recurringEvent": {
"id": "<string>",
"rrule": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"durationMinutes": 123,
"timezone": "<string>",
"type": "APPOINTMENT",
"title": "<string>",
"organizerId": "<string>",
"serviceIds": [
"<string>"
],
"capacity": 123,
"attendeeIds": [
"<string>"
],
"locationId": "<string>"
},
"eventServices": [],
"icons": [],
"capacity": 123
}
]
}
]
}Calendar
Get Shifts By Date
Get all shifts for a specific date with provider information
GET
/
calendar
/
shifts
/
by-date
Get Shifts By Date
Copy
curl --request GET \
--url https://api.decodahealth.com/calendar/shifts/by-date \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'Copy
{
"date": "<string>",
"providers": [
{
"provider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
},
"shifts": [
{
"id": "<string>",
"title": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"type": "APPOINTMENT",
"status": "PENDING",
"location": {
"id": "<string>",
"isVirtual": true
},
"attendees": [],
"recurringEventId": "<string>",
"recurringEvent": {
"id": "<string>",
"rrule": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"durationMinutes": 123,
"timezone": "<string>",
"type": "APPOINTMENT",
"title": "<string>",
"organizerId": "<string>",
"serviceIds": [
"<string>"
],
"capacity": 123,
"attendeeIds": [
"<string>"
],
"locationId": "<string>"
},
"eventServices": [],
"icons": [],
"capacity": 123
}
],
"appointments": [
{
"id": "<string>",
"title": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"type": "APPOINTMENT",
"status": "PENDING",
"location": {
"id": "<string>",
"isVirtual": true
},
"attendees": [],
"recurringEventId": "<string>",
"recurringEvent": {
"id": "<string>",
"rrule": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"durationMinutes": 123,
"timezone": "<string>",
"type": "APPOINTMENT",
"title": "<string>",
"organizerId": "<string>",
"serviceIds": [
"<string>"
],
"capacity": 123,
"attendeeIds": [
"<string>"
],
"locationId": "<string>"
},
"eventServices": [],
"icons": [],
"capacity": 123
}
]
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Query Parameters
Date in YYYY-MM-DD format
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
APPOINTMENT, SHIFT, BLOCK Available options:
PENDING, RESERVED, CONFIRMED, CANCELLED, COMPLETED, OVERRIDABLE, NO_SHOW Show child attributes
Show child attributes
Show child attributes
Show child attributes
The unique identifier for the user.
The type of user.
Available options:
PROVIDER, PATIENT, ASSISTANT The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.
Available options:
PENDING, ACCEPTED, REJECTED Show child attributes
Show child attributes
Available options:
APPOINTMENT, SHIFT, BLOCK Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
BOOKING_FEE_PAID, NEW_PATIENT, SCHEDULED_BY_AI, FORM_COMPLETED, CHECKED_IN Show child attributes
Show child attributes
Available options:
APPOINTMENT, SHIFT, BLOCK Available options:
PENDING, RESERVED, CONFIRMED, CANCELLED, COMPLETED, OVERRIDABLE, NO_SHOW Show child attributes
Show child attributes
Show child attributes
Show child attributes
The unique identifier for the user.
The type of user.
Available options:
PROVIDER, PATIENT, ASSISTANT The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.
Available options:
PENDING, ACCEPTED, REJECTED Show child attributes
Show child attributes
Available options:
APPOINTMENT, SHIFT, BLOCK Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
BOOKING_FEE_PAID, NEW_PATIENT, SCHEDULED_BY_AI, FORM_COMPLETED, CHECKED_IN ⌘I