--- title: Get a list of Pets slug: import-test-pdf/get-a-list-of-pets createdAt: 2025-10-28T16:28:34.263Z --- { "id": "HmGXOW5k7q_whOy7p3poO", "type": "api-oas-v2", "data": { "method": "GET", "url": "/api/v1/pets", "servers": [], "name": "Get a list of Pets", "description": "Returns list of Pets", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [ { "kind": "required", "name": "filter[clinic_id]", "type": "integer", "description": "ID of the clinic from where the entity was created" }, { "kind": "optional", "name": "filter[vet_id]", "type": "integer", "description": "

Id of the vet that performed/owns the entity

" }, { "kind": "optional", "name": "filter[owner_id]", "type": "integer", "example": 1, "description": "Id of the related PetParent" }, { "kind": "optional", "name": "filter[id]", "type": "integer", "description": "Pet ID" }, { "kind": "optional", "name": "filter[nickname]", "type": "string", "description": "Pet nickname" }, { "kind": "optional", "name": "filter[updated_from]", "type": "string", "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

" }, { "kind": "optional", "name": "filter[updated_to]", "type": "string", "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

" }, { "kind": "optional", "name": "include", "type": "string", "description": "

Additional info to include. You can use multiple, comma separated. Options: species,breed,crossBreed, owners

" }, { "kind": "optional", "name": "sort", "type": "string", "description": "

Order by field(s)(ex: 'nickname,created_at,name-archived-last -> order by nickname with archived pets at the end')

" }, { "kind": "optional", "name": "page", "type": "integer", "description": "

Page (on pagination, default 1)

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/Pet", "customType": "Pet[]", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "nickname", "kind": "optional", "type": "string", "description": "", "example": "Fritz" }, { "name": "species_id", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "breed_id", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "observations", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "gender", "kind": "optional", "type": "string", "description": "", "example": "male" }, { "name": "microchip", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "crossbreed", "kind": "optional", "type": "string<0 | 1>", "description": "", "example": "0" }, { "name": "crossbreed_details_id", "kind": "optional", "type": "integer", "description": "", "example": "" }, { "name": "color", "kind": "optional", "type": "string", "description": "", "example": "NavajoWhite" }, { "name": "distinctive_marks", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "birthday", "kind": "optional", "type": "string", "description": "", "example": "1983-03-29" }, { "name": "gender_string", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "chip_number", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "microchip_location", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "insurance_number", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "passport", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "profile_picture", "kind": "optional", "type": "string", "description": "", "example": "https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2" }, { "name": "description", "kind": "optional", "type": "string", "description": "", "example": "Lorem ipsum" }, { "name": "constitution", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "conformation", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "weight", "kind": "optional", "type": "number", "description": "", "example": "" }, { "name": "allergies", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "nr_recs", "kind": "optional", "type": "integer", "description": "", "example": "" }, { "name": "blood_type", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "hormonal_status", "kind": "optional", "type": "integer", "description": "0: 'Unknown' 1: 'Intact' 2: 'Neutered'\n", "example": 0 }, { "name": "age", "kind": "optional", "type": "string", "description": "", "example": "38 Years, 3 Months, 19 Days" }, { "name": "patientNumber", "kind": "optional", "type": "string", "description": "", "example": "mxc-1 #jwq-1" }, { "name": "is_verified", "kind": "optional", "type": "string<0 | 1>", "description": "", "example": "1" }, { "name": "breeder", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "archive", "kind": "optional", "type": "object", "description": "Slim resource for archive, usually attached to other resources", "modelRef": "#/components/schemas/Archive", "customType": "Archive", "schema": [ { "name": "id", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "reason", "kind": "optional", "type": "string", "description": "", "example": "The patient was archived because..." }, { "name": "type", "kind": "optional", "type": "string", "description": "", "example": "Deceased" } ] }, { "name": "birthday_estimated", "kind": "optional", "type": "boolean", "description": "", "example": false }, { "name": "rabic_tag_number", "kind": "optional", "type": "string", "description": "", "example": "12109384" }, { "name": "updated_at", "kind": "optional", "type": "string", "description": "", "example": "2020-06-12 15:45:43" } ] }, { "name": "links", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "first", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "last", "kind": "optional", "type": "string", "description": "", "example": "https://developer.digitail.io/api/v1/entities?page=10" }, { "name": "prev", "kind": "optional", "type": "string", "description": "", "example": "" }, { "name": "next", "kind": "optional", "type": "string", "description": "", "example": "https://developer.digitail.io/api/v1/entities?page=2" } ] }, { "name": "meta", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "current_page", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "from", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "last_page", "kind": "optional", "type": "integer", "description": "", "example": 10 }, { "name": "links", "kind": "optional", "type": "array", "description": "", "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}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "url", "kind": "optional", "type": "string", "description": "", "example": "« Previous" } ] }, { "name": "path", "kind": "optional", "type": "string", "description": "", "example": "https://developer.digitail.io/api/v1/entities" }, { "name": "per_page", "kind": "optional", "type": "integer", "description": "", "example": 15 }, { "name": "to", "kind": "optional", "type": "integer", "description": "", "example": 10 }, { "name": "total", "kind": "optional", "type": "integer", "description": "", "example": 145 } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "429", "description": "Too Many Requests", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url '/api/v1/pets?filter[clinic_id]=integer' \\\n --header 'accept: application/json'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"/api/v1/pets?filter[clinic_id]=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/api/v1/pets?filter[clinic_id]=integer\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/api/v1/pets?filter[clinic_id]=integer\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful operation\n{\n \"data\": [\n {\n \"id\": 1,\n \"nickname\": \"Fritz\",\n \"species_id\": \"1\",\n \"breed_id\": \"1\",\n \"observations\": \"\",\n \"gender\": \"male\",\n \"microchip\": \"\",\n \"crossbreed\": \"0\",\n \"crossbreed_details_id\": 0,\n \"color\": \"NavajoWhite\",\n \"distinctive_marks\": \"\",\n \"birthday\": \"1983-03-29\",\n \"gender_string\": \"\",\n \"chip_number\": \"\",\n \"microchip_location\": \"\",\n \"insurance_number\": \"\",\n \"passport\": \"\",\n \"profile_picture\": \"https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2\",\n \"description\": \"Lorem ipsum\",\n \"constitution\": \"\",\n \"conformation\": \"\",\n \"weight\": 0,\n \"allergies\": \"\",\n \"nr_recs\": 0,\n \"blood_type\": \"\",\n \"hormonal_status\": 0,\n \"age\": \"38 Years, 3 Months, 19 Days\",\n \"patientNumber\": \"mxc-1 #jwq-1\",\n \"is_verified\": \"1\",\n \"breeder\": \"\",\n \"archive\": {\n \"id\": 1,\n \"reason\": \"The patient was archived because...\",\n \"type\": \"Deceased\"\n },\n \"birthday_estimated\": false,\n \"rabic_tag_number\": \"12109384\",\n \"updated_at\": \"2020-06-12 15:45:43\"\n }\n ],\n \"links\": {\n \"first\": \"\",\n \"last\": \"https://developer.digitail.io/api/v1/entities?page=10\",\n \"prev\": \"\",\n \"next\": \"https://developer.digitail.io/api/v1/entities?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 10,\n \"links\": [\n {\n \"url\": \"« Previous\"\n }\n ],\n \"path\": \"https://developer.digitail.io/api/v1/entities\",\n \"per_page\": 15,\n \"to\": 10,\n \"total\": 145\n }\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request\n" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-3-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-4-429", "language": "429", "code": "// Too Many Requests\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }