List the pet parent's Health Checks

1 min

GET

https://developer.digitail.io/api/v1/for-pet-parents/health-checks

Paginated list of the authenticated pet parent's Health Checks across every pet they own, newest first. Health Checks belonging to clinics that do not have the Health Checks feature enabled are excluded. Filter with filter[status]=open to return only the pending or in-progress conversations the app can still reopen.

Query Parameters

per_pageinteger
Default
25
Minimum
1
Maximum
100
filter[status]string
Description
open returns the pending or in-progress checks a conversation can still be reopened in. Omit to return all of the pet parent's checks.
Allowed
open

Responses

200successful operation

object
- dataobject[]
  - idintegerrequired
    Example
    1024
  - pet_idintegerrequired
    Example
    552
  - cometchat_group_guidstringrequired
    Example
    health-check-1024
    Description
    GUID of the CometChat group carrying this Health Check conversation.
  - statusstring<pending | in-progress | completed | expired | not-answered>required
    Example
    pending
    Allowed
    pendingin-progresscompletedexpirednot-answered
  - escalation_statusstring<concerning | not-concerning>required
    Example
    not-concerning
    Description
    Clinical assessment of the completed Health Check. Null until the check has been assessed.
    Allowed
    concerningnot-concerning
  - escalatedbooleanrequired
    Description
    Whether this Health Check has been escalated for clinical attention.
- linkslinks
- metameta

curl

curl --request GET \
     --url 'https://developer.digitail.io/api/v1/for-pet-parents/health-checks?per_page=25' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://developer.digitail.io/api/v1/for-pet-parents/health-checks?per_page=25", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://developer.digitail.io/api/v1/for-pet-parents/health-checks?per_page=25")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://developer.digitail.io/api/v1/for-pet-parents/health-checks?per_page=25"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// successful operation
{
  "data": [
    {
      "id": 1024,
      "pet_id": 552,
      "cometchat_group_guid": "health-check-1024",
      "status": "pending",
      "escalation_status": "not-concerning",
      "escalated": false
    }
  ],
  "links": {},
  "meta": {}
}