Task records
List tasks
GET
/
api
/
care
/
tasks
/
List tasks
curl --request GET \
--url https://api.prod.peerlogic.com/api/care/tasks/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.prod.peerlogic.com/api/care/tasks/"
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/tasks/', 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/tasks/",
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/tasks/"
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/tasks/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.peerlogic.com/api/care/tasks/")
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": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"contact": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"name_first": "<string>",
"name_last": "<string>",
"name_middle": "<string>",
"name_preferred": "<string>",
"organization": "<string>",
"title": "<string>",
"email": "jsmith@example.com",
"phone_numbers": [
{
"id": "<string>",
"phone_number": "<string>",
"source_type": "call",
"sip_caller_name": "<string>",
"is_primary_contact": true,
"phone_number_type": "home"
}
],
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_city": "<string>",
"address_state": "<string>",
"zip_code": "<string>",
"date_of_birth": "2023-12-25",
"gender": "male",
"manually_edited_fields": "<string>"
},
"task_type": "BILLING_COLLECTION",
"practice_id": "<string>",
"assignee_type": "AIMEE",
"status": "CREATED",
"due_at": "2023-11-07T05:31:56Z",
"handoff_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"handoff_reason": "aimee_initiated",
"handoff_notes": "<string>",
"completed_by_type": "AIMEE",
"patients": [
{
"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>"
}
],
"conversations": [
"<string>"
],
"opportunities": [
"<string>"
],
"appointments": [
{
"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>"
}
}
],
"task_description": "<string>",
"task_type_display": "<string>",
"handoff_reason_display": "<string>",
"task_category": "<string>",
"is_viewed": true,
"is_high_priority": true,
"detail": "<string>"
}
],
"next": "<string>",
"previous": "<string>"
}{
"non_field_errors": [
"You must provide either 'practice_id' or 'conversation_id'."
]
}{
"detail": "'Authorization' header is required"
}{
"message": "No permissions assigned to permit access to this endpoint."
}Authorizations
Bearer access token issued by Peerlogic.
Query Parameters
practice_id
conversation_id
task_type
status
assignee_type
Available options:
AIMEE, STAFF task_category
is_viewed
Contact ID
Patient ID
A search term.
Which field to use when ordering the results.
A page number within the paginated result set.
Number of results to return per page.
Was this page helpful?
List tasks
curl --request GET \
--url https://api.prod.peerlogic.com/api/care/tasks/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.prod.peerlogic.com/api/care/tasks/"
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/tasks/', 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/tasks/",
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/tasks/"
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/tasks/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.peerlogic.com/api/care/tasks/")
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": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z",
"contact": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"name_first": "<string>",
"name_last": "<string>",
"name_middle": "<string>",
"name_preferred": "<string>",
"organization": "<string>",
"title": "<string>",
"email": "jsmith@example.com",
"phone_numbers": [
{
"id": "<string>",
"phone_number": "<string>",
"source_type": "call",
"sip_caller_name": "<string>",
"is_primary_contact": true,
"phone_number_type": "home"
}
],
"address_line_1": "<string>",
"address_line_2": "<string>",
"address_city": "<string>",
"address_state": "<string>",
"zip_code": "<string>",
"date_of_birth": "2023-12-25",
"gender": "male",
"manually_edited_fields": "<string>"
},
"task_type": "BILLING_COLLECTION",
"practice_id": "<string>",
"assignee_type": "AIMEE",
"status": "CREATED",
"due_at": "2023-11-07T05:31:56Z",
"handoff_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"handoff_reason": "aimee_initiated",
"handoff_notes": "<string>",
"completed_by_type": "AIMEE",
"patients": [
{
"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>"
}
],
"conversations": [
"<string>"
],
"opportunities": [
"<string>"
],
"appointments": [
{
"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>"
}
}
],
"task_description": "<string>",
"task_type_display": "<string>",
"handoff_reason_display": "<string>",
"task_category": "<string>",
"is_viewed": true,
"is_high_priority": true,
"detail": "<string>"
}
],
"next": "<string>",
"previous": "<string>"
}{
"non_field_errors": [
"You must provide either 'practice_id' or 'conversation_id'."
]
}{
"detail": "'Authorization' header is required"
}{
"message": "No permissions assigned to permit access to this endpoint."
}