---
title: Get a Pet record by ID
slug: import-test-pdf/get-a-pet-record-by-id
createdAt: 2025-10-28T16:28:34.263Z
---
{
"id": "AS3K7ykkbbqMUlga1NQcN",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "/api/v1/pets/{id}",
"servers": [],
"name": "Get a Pet record by ID",
"description": "Returns a Pet record",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "id",
"type": "integer",
"description": "The entity id"
}
],
"headerParameters": [],
"queryParameters": [
{
"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": "append",
"type": "string",
"description": "Additional attributes to include(comma separated attributes. Ex: hormonalStatusString)
"
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": []
},
"responses": [
{
"statusCode": "200",
"description": "Successful operation",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"schema": [
{
"name": "data",
"kind": "optional",
"type": "object",
"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"
}
]
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url /api/v1/pets/{id} \\\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/{id}\", 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/{id}\")\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/{id}\"\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 \"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}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"text": ""
}
]
}