Get a list of Pets

1 min

GET

/api/v1/pets

Returns list of Pets

Query Parameters

filter[clinic_id]integerrequired
Description
ID of the clinic from where the entity was created
filter[vet_id]integer
Description
Id of the vet that performed/owns the entity
filter[owner_id]integer
Example
1
Description
Id of the related PetParent
filter[id]integer
Description
Pet ID
filter[nickname]string
Description
Pet nickname
filter[updated_from]string<date-time>
Description
Updated after the datetime (use iso8601 format - 2020-08-16T08:56
.000000Z). Updated at and created at are returned in UTC in the response
filter[updated_to]string<date-time>
Description
Updated at less or equal than the datetime (use iso8601 format - 2020-08-16T08:56
.000000Z). Updated at and created at are returned in UTC in the response
includestring
Description
Additional info to include. You can use multiple, comma separated. Options: species,breed,crossBreed, owners
sortstring
Description
Order by field(s)(ex: 'nickname,created_at,name-archived-last -> order by nickname with archived pets at the end')
pageinteger
Description
Page (on pagination, default 1)

Responses

200Successful operation

object
- dataPet[]
  - idinteger
    Example
    1
  - nicknamestring
    Example
    Fritz
  - species_idstring
    Example
    1
  - breed_idstring
    Example
    1
  - observationsstring
  - genderstring<male | female | unknown>
    Example
    male
  - microchipstring
  - crossbreedstring<0 | 1>
    Example
    0
  - crossbreed_details_idinteger
  - colorstring
    Example
    NavajoWhite
  - distinctive_marksstring
  - birthdaystring<date>
    Example
    1983-03-29
  - gender_stringstring
  - chip_numberstring
  - microchip_locationstring
  - insurance_numberstring
  - passportstring
  - profile_picturestring
    Example
    https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2
  - descriptionstring
    Example
    Lorem ipsum
  - constitutionstring
  - conformationstring
  - weightnumber
  - allergiesstring
  - nr_recsinteger
  - blood_typestring
  - hormonal_statusinteger
    Description
    0: 'Unknown' 1: 'Intact' 2: 'Neutered'
  - agestring
    Example
    38 Years, 3 Months, 19 Days
  - patientNumberstring
    Example
    mxc-1 #jwq-1
  - is_verifiedstring<0 | 1>
    Example
    1
  - breederstring
  - archiveArchive
    Description
    Slim resource for archive, usually attached to other resources
    - idinteger
      Example
      1
    - reasonstring
      Example
      The patient was archived because...
    - typestring<Deceased | Moved away | Change of owner | Other>
      Example
      Deceased
  - birthday_estimatedboolean
  - rabic_tag_numberstring
    Example
    12109384
  - updated_atstring<date-time>
    Example
    2020-06-12 15:45:43
- linksobject
  - firststring
  - laststring
    Example
    https://developer.digitail.io/api/v1/entities?page=10
  - prevstring
  - nextstring
    Example
    https://developer.digitail.io/api/v1/entities?page=2
- metaobject
  - current_pageinteger
    Example
    1
  - frominteger
    Example
    1
  - last_pageinteger
    Example
    10
  - linksobject[]
    Example
    [ { "url": null, "label": "« Previous", "active": false }, { "url": "https://developer.digitail.io/api/v1/entities?page=1", "label": "1", "active": true }, { "url": "https://developer.digitail.io/api/v1/entities?page=2", "label": "Next »", "active": true } ]
    - urlstring
      Example
      « Previous
  - pathstring
    Example
    https://developer.digitail.io/api/v1/entities
  - per_pageinteger
    Example
    15
  - tointeger
    Example
    10
  - totalinteger
    Example
    145

400Bad Request

401Unauthorized

403Forbidden

429Too Many Requests

curl

curl --request GET \
     --url '/api/v1/pets?filter[clinic_id]=integer' \
     --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("/api/v1/pets?filter[clinic_id]=integer", 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("/api/v1/pets?filter[clinic_id]=integer")

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

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

python

import requests
import json

url = "/api/v1/pets?filter[clinic_id]=integer"

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": 1,
      "nickname": "Fritz",
      "species_id": "1",
      "breed_id": "1",
      "observations": "",
      "gender": "male",
      "microchip": "",
      "crossbreed": "0",
      "crossbreed_details_id": 0,
      "color": "NavajoWhite",
      "distinctive_marks": "",
      "birthday": "1983-03-29",
      "gender_string": "",
      "chip_number": "",
      "microchip_location": "",
      "insurance_number": "",
      "passport": "",
      "profile_picture": "https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2",
      "description": "Lorem ipsum",
      "constitution": "",
      "conformation": "",
      "weight": 0,
      "allergies": "",
      "nr_recs": 0,
      "blood_type": "",
      "hormonal_status": 0,
      "age": "38 Years, 3 Months, 19 Days",
      "patientNumber": "mxc-1 #jwq-1",
      "is_verified": "1",
      "breeder": "",
      "archive": {
        "id": 1,
        "reason": "The patient was archived because...",
        "type": "Deceased"
      },
      "birthday_estimated": false,
      "rabic_tag_number": "12109384",
      "updated_at": "2020-06-12 15:45:43"
    }
  ],
  "links": {
    "first": "",
    "last": "https://developer.digitail.io/api/v1/entities?page=10",
    "prev": "",
    "next": "https://developer.digitail.io/api/v1/entities?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "links": [
      {
        "url": "&laquo; Previous"
      }
    ],
    "path": "https://developer.digitail.io/api/v1/entities",
    "per_page": 15,
    "to": 10,
    "total": 145
  }
}

400

// Bad Request

401

// Unauthorized

403

// Forbidden

429

// Too Many Requests