Appointments
List patient appointments
Returns previous and upcoming appointments for the selected patients. Provide at least one patient ID or booking patient ID.
GET
/
api
/
care
/
appointments
/
List patient appointments
curl --request GET \
--url https://api.prod.peerlogic.com/api/care/appointments/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.prod.peerlogic.com/api/care/appointments/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.prod.peerlogic.com/api/care/appointments/', 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.prod.peerlogic.com/api/care/appointments/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.prod.peerlogic.com/api/care/appointments/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.prod.peerlogic.com/api/care/appointments/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.peerlogic.com/api/care/appointments/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"count": 123,
"results": [
{
"id": 123,
"appointment_start_at": "2023-11-07T05:31:56Z",
"appointment_end_at": "2023-11-07T05:31:56Z",
"approximate_total_amount": "<string>",
"approximate_total_currency": "<string>",
"confirmed_at": "2023-11-07T05:31:56Z",
"did_patient_miss": true,
"is_active": true,
"is_new_patient": true,
"note": "<string>",
"patient_id": "<string>",
"booked_by_patient_id": "<string>",
"pms_created_at": "2023-11-07T05:31:56Z",
"practice": "<string>",
"procedures": "<string>",
"status": "SCHEDULED",
"appointment_type": {
"id": "<string>",
"name": "<string>",
"duration_in_minutes": 123,
"practice": "<string>",
"descriptors": [
{
"name": "<string>",
"code": "<string>",
"id": "<string>",
"active": true
}
],
"peerlogic_appointment_types": "<string>",
"mappings": "<string>",
"is_bookable_online": true,
"is_disabled_in_peerlogic": true,
"effective_is_bookable_online": "<string>",
"has_availability_schedule": true
},
"booked_peerlogic_appointment_type": {
"id": "<string>",
"name": "Consultation",
"display_name": "<string>"
},
"patient": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"date_of_birth": "2023-12-25",
"email": "jsmith@example.com",
"id": "<string>",
"is_active": true,
"name": "<string>",
"name_first": "<string>",
"name_last": "<string>",
"name_middle": "<string>",
"phone_fax": "<string>",
"phone_home": "<string>",
"phone_mobile": "<string>",
"phone_number": "<string>",
"phone_work": "<string>",
"placeholder": "<string>",
"pms_created_at": "2023-11-07T05:31:56Z",
"zip_code": "<string>"
},
"provider": {
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phone_number": "<string>",
"is_active": true
},
"operatory": {
"name": "<string>",
"id": "<string>",
"display_name": "<string>"
}
}
],
"next": "<string>",
"previous": "<string>"
}{
"practice_id": [
"This field is required."
]
}{
"detail": "'Authorization' header is required"
}{
"message": "No permissions assigned to permit access to this endpoint."
}{
"error": "The connected practice-management system could not fulfill the request."
}Authorizations
Bearer access token issued by Peerlogic.
Query Parameters
Practice ID.
One or more patient IDs.
One or more IDs for patients or clients who booked the appointment.
Return appointments starting at or after this timestamp.
Return appointments starting at or before this timestamp.
Limit results to one or more appointment statuses.
Refresh appointments from the connected practice-management system.
When refreshing, limit synchronization to the latest appointments.
Page number.
Required range:
x >= 1Number of records to return per page.
Required range:
x >= 1Was this page helpful?
List patient appointments
curl --request GET \
--url https://api.prod.peerlogic.com/api/care/appointments/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.prod.peerlogic.com/api/care/appointments/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.prod.peerlogic.com/api/care/appointments/', 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.prod.peerlogic.com/api/care/appointments/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.prod.peerlogic.com/api/care/appointments/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.prod.peerlogic.com/api/care/appointments/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.peerlogic.com/api/care/appointments/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"count": 123,
"results": [
{
"id": 123,
"appointment_start_at": "2023-11-07T05:31:56Z",
"appointment_end_at": "2023-11-07T05:31:56Z",
"approximate_total_amount": "<string>",
"approximate_total_currency": "<string>",
"confirmed_at": "2023-11-07T05:31:56Z",
"did_patient_miss": true,
"is_active": true,
"is_new_patient": true,
"note": "<string>",
"patient_id": "<string>",
"booked_by_patient_id": "<string>",
"pms_created_at": "2023-11-07T05:31:56Z",
"practice": "<string>",
"procedures": "<string>",
"status": "SCHEDULED",
"appointment_type": {
"id": "<string>",
"name": "<string>",
"duration_in_minutes": 123,
"practice": "<string>",
"descriptors": [
{
"name": "<string>",
"code": "<string>",
"id": "<string>",
"active": true
}
],
"peerlogic_appointment_types": "<string>",
"mappings": "<string>",
"is_bookable_online": true,
"is_disabled_in_peerlogic": true,
"effective_is_bookable_online": "<string>",
"has_availability_schedule": true
},
"booked_peerlogic_appointment_type": {
"id": "<string>",
"name": "Consultation",
"display_name": "<string>"
},
"patient": {
"address_line_1": "<string>",
"address_line_2": "<string>",
"date_of_birth": "2023-12-25",
"email": "jsmith@example.com",
"id": "<string>",
"is_active": true,
"name": "<string>",
"name_first": "<string>",
"name_last": "<string>",
"name_middle": "<string>",
"phone_fax": "<string>",
"phone_home": "<string>",
"phone_mobile": "<string>",
"phone_number": "<string>",
"phone_work": "<string>",
"placeholder": "<string>",
"pms_created_at": "2023-11-07T05:31:56Z",
"zip_code": "<string>"
},
"provider": {
"id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phone_number": "<string>",
"is_active": true
},
"operatory": {
"name": "<string>",
"id": "<string>",
"display_name": "<string>"
}
}
],
"next": "<string>",
"previous": "<string>"
}{
"practice_id": [
"This field is required."
]
}{
"detail": "'Authorization' header is required"
}{
"message": "No permissions assigned to permit access to this endpoint."
}{
"error": "The connected practice-management system could not fulfill the request."
}