Get Shifts By Date
curl --request GET \
--url https://api.decodahealth.com/check-in/calendar/shifts/by-date \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/check-in/calendar/shifts/by-date"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/check-in/calendar/shifts/by-date', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/check-in/calendar/shifts/by-date",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/check-in/calendar/shifts/by-date"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.decodahealth.com/check-in/calendar/shifts/by-date")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/check-in/calendar/shifts/by-date")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"date": "<string>",
"providers": [
{
"provider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
},
"shifts": [
{
"id": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"title": "<string>",
"isAllDay": false,
"location": {
"id": "<string>",
"isVirtual": true
},
"roomId": "<string>",
"attendees": [],
"recurringEventId": "<string>",
"recurringEvent": {
"id": "<string>",
"rrule": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"durationMinutes": 123,
"timezone": "<string>",
"organizerId": "<string>",
"segments": [
{
"serviceId": "<string>",
"bookableId": "<string>",
"bookableGroupId": "<string>",
"providerId": "<string>",
"title": "<string>",
"color": "<string>",
"durationMinutes": 123,
"bufferMinutes": 123,
"offsetMinutes": 123
}
],
"serviceIds": [
"<string>"
],
"bookableIds": [
"<string>"
],
"capacity": 123,
"description": "<string>",
"patientRequestedProvider": true,
"isBusinessBlock": true,
"title": "<string>",
"attendeeIds": [
"<string>"
],
"locationId": "<string>",
"externalId": "<string>"
},
"segments": [],
"icons": [],
"capacity": 123,
"quickNotes": [
{
"id": "<string>",
"patientId": "<string>",
"note": "<string>",
"creator": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"eventId": "<string>",
"externalId": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isArchived": false,
"isPinned": false
}
],
"carePlan": {
"carePlanId": "<string>",
"stepNumber": 123,
"carePlanName": "<string>",
"status": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"meetingLink": "<string>",
"description": "<string>",
"gcalBusy": true,
"patientRequestedProvider": false,
"isBusinessBlock": false
}
],
"appointments": [
{
"id": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"title": "<string>",
"isAllDay": false,
"location": {
"id": "<string>",
"isVirtual": true
},
"roomId": "<string>",
"attendees": [],
"recurringEventId": "<string>",
"recurringEvent": {
"id": "<string>",
"rrule": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"durationMinutes": 123,
"timezone": "<string>",
"organizerId": "<string>",
"segments": [
{
"serviceId": "<string>",
"bookableId": "<string>",
"bookableGroupId": "<string>",
"providerId": "<string>",
"title": "<string>",
"color": "<string>",
"durationMinutes": 123,
"bufferMinutes": 123,
"offsetMinutes": 123
}
],
"serviceIds": [
"<string>"
],
"bookableIds": [
"<string>"
],
"capacity": 123,
"description": "<string>",
"patientRequestedProvider": true,
"isBusinessBlock": true,
"title": "<string>",
"attendeeIds": [
"<string>"
],
"locationId": "<string>",
"externalId": "<string>"
},
"segments": [],
"icons": [],
"capacity": 123,
"quickNotes": [
{
"id": "<string>",
"patientId": "<string>",
"note": "<string>",
"creator": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"eventId": "<string>",
"externalId": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isArchived": false,
"isPinned": false
}
],
"carePlan": {
"carePlanId": "<string>",
"stepNumber": 123,
"carePlanName": "<string>",
"status": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"meetingLink": "<string>",
"description": "<string>",
"gcalBusy": true,
"patientRequestedProvider": false,
"isBusinessBlock": false
}
]
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Calendar and Appointments
Get Shifts By Date
Get all shifts for a specific date with provider information
GET
/
check-in
/
calendar
/
shifts
/
by-date
Get Shifts By Date
curl --request GET \
--url https://api.decodahealth.com/check-in/calendar/shifts/by-date \
--header 'API-KEY: <api-key>' \
--header 'TENANT: <tenant>'import requests
url = "https://api.decodahealth.com/check-in/calendar/shifts/by-date"
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};
fetch('https://api.decodahealth.com/check-in/calendar/shifts/by-date', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/check-in/calendar/shifts/by-date",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/check-in/calendar/shifts/by-date"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.decodahealth.com/check-in/calendar/shifts/by-date")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/check-in/calendar/shifts/by-date")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"date": "<string>",
"providers": [
{
"provider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
},
"shifts": [
{
"id": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"title": "<string>",
"isAllDay": false,
"location": {
"id": "<string>",
"isVirtual": true
},
"roomId": "<string>",
"attendees": [],
"recurringEventId": "<string>",
"recurringEvent": {
"id": "<string>",
"rrule": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"durationMinutes": 123,
"timezone": "<string>",
"organizerId": "<string>",
"segments": [
{
"serviceId": "<string>",
"bookableId": "<string>",
"bookableGroupId": "<string>",
"providerId": "<string>",
"title": "<string>",
"color": "<string>",
"durationMinutes": 123,
"bufferMinutes": 123,
"offsetMinutes": 123
}
],
"serviceIds": [
"<string>"
],
"bookableIds": [
"<string>"
],
"capacity": 123,
"description": "<string>",
"patientRequestedProvider": true,
"isBusinessBlock": true,
"title": "<string>",
"attendeeIds": [
"<string>"
],
"locationId": "<string>",
"externalId": "<string>"
},
"segments": [],
"icons": [],
"capacity": 123,
"quickNotes": [
{
"id": "<string>",
"patientId": "<string>",
"note": "<string>",
"creator": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"eventId": "<string>",
"externalId": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isArchived": false,
"isPinned": false
}
],
"carePlan": {
"carePlanId": "<string>",
"stepNumber": 123,
"carePlanName": "<string>",
"status": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"meetingLink": "<string>",
"description": "<string>",
"gcalBusy": true,
"patientRequestedProvider": false,
"isBusinessBlock": false
}
],
"appointments": [
{
"id": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"title": "<string>",
"isAllDay": false,
"location": {
"id": "<string>",
"isVirtual": true
},
"roomId": "<string>",
"attendees": [],
"recurringEventId": "<string>",
"recurringEvent": {
"id": "<string>",
"rrule": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"durationMinutes": 123,
"timezone": "<string>",
"organizerId": "<string>",
"segments": [
{
"serviceId": "<string>",
"bookableId": "<string>",
"bookableGroupId": "<string>",
"providerId": "<string>",
"title": "<string>",
"color": "<string>",
"durationMinutes": 123,
"bufferMinutes": 123,
"offsetMinutes": 123
}
],
"serviceIds": [
"<string>"
],
"bookableIds": [
"<string>"
],
"capacity": 123,
"description": "<string>",
"patientRequestedProvider": true,
"isBusinessBlock": true,
"title": "<string>",
"attendeeIds": [
"<string>"
],
"locationId": "<string>",
"externalId": "<string>"
},
"segments": [],
"icons": [],
"capacity": 123,
"quickNotes": [
{
"id": "<string>",
"patientId": "<string>",
"note": "<string>",
"creator": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"eventId": "<string>",
"externalId": "<string>",
"updatedDate": "2023-11-07T05:31:56Z",
"isArchived": false,
"isPinned": false
}
],
"carePlan": {
"carePlanId": "<string>",
"stepNumber": 123,
"carePlanName": "<string>",
"status": "<string>"
},
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"meetingLink": "<string>",
"description": "<string>",
"gcalBusy": true,
"patientRequestedProvider": false,
"isBusinessBlock": false
}
]
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}⌘I
