---
title: Get a list of pet parents
slug: import-test-pdf/get-a-list-of-pet-parents
createdAt: 2025-10-28T16:28:34.261Z
---
{
"id": "UQJNHhKYUocyExAYHjVjn",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "/api/v1/pet-parents",
"servers": [],
"name": "Get a list of pet parents",
"description": "Returns a filtered & ordered list of all pet parents
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [],
"queryParameters": [
{
"kind": "optional",
"name": "includes",
"type": "array",
"description": "Which relationships should be included in the response",
"schema": [],
"itemType": "string",
"customType": "string[]"
},
{
"kind": "optional",
"name": "filter[has_app]",
"type": "boolean",
"description": "If the pet parent has the app downloaded or not"
},
{
"kind": "optional",
"name": "filter[phone]",
"type": "string",
"description": "Partial phone filter"
},
{
"kind": "optional",
"name": "filter[email]",
"type": "string",
"description": "Filter by email address"
},
{
"kind": "optional",
"name": "filter[belongs_to_clinic]",
"type": "integer",
"description": "Filter only by the pet parent that are associated to a specific clinic's id"
},
{
"kind": "optional",
"name": "add_address_metadata",
"type": "integer",
"description": "Set to 1 to get the full address details"
},
{
"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"
}
],
"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/PetParent",
"customType": "PetParent[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 1
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "John"
},
{
"name": "last_name",
"kind": "optional",
"type": "string",
"description": "",
"example": "Doe"
},
{
"name": "email",
"kind": "optional",
"type": "string",
"description": "",
"example": "john@example.com"
},
{
"name": "phone",
"kind": "optional",
"type": "string",
"description": "In E164 format",
"example": "+19772480544"
},
{
"name": "secondary_phone",
"kind": "optional",
"type": "string",
"description": "In E164 format",
"example": "+19772480544"
},
{
"name": "chatUid",
"kind": "optional",
"type": "string",
"description": "",
"example": "cjfiem-c9hg-apzm-23sod"
},
{
"name": "has_app",
"kind": "optional",
"type": "boolean",
"description": "",
"example": true
},
{
"name": "has_app_date",
"kind": "optional",
"type": "string",
"description": "",
"example": "2020-06-12 15:45:43"
},
{
"name": "enable_chat_without_app",
"kind": "optional",
"type": "boolean",
"description": "",
"example": false
},
{
"name": "created_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2020-06-12 15:45:43"
},
{
"name": "updated_at",
"kind": "optional",
"type": "string",
"description": "",
"example": "2020-06-12 15:45:43"
},
{
"name": "address",
"kind": "optional",
"type": "string",
"description": "",
"example": "Flowers St. 300, Palo Alto, 123456, USA"
},
{
"name": "address_2",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
},
{
"name": "city",
"kind": "optional",
"type": "string",
"description": "",
"example": "Buenos Aires"
},
{
"name": "birthdate",
"kind": "optional",
"type": "string",
"description": "",
"example": "1990-04-04"
},
{
"name": "observations",
"kind": "optional",
"type": "string",
"description": "",
"example": "happy"
},
{
"name": "cnp",
"kind": "optional",
"type": "string",
"description": "",
"example": "1234567890123"
},
{
"name": "chip_number",
"kind": "optional",
"type": "string",
"description": "",
"example": "99281028"
},
{
"name": "discounts",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/Discount",
"customType": "Discount[]",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 10
},
{
"name": "name",
"kind": "optional",
"type": "string",
"description": "",
"example": "digitail disc10"
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "",
"example": "digitail disc10"
},
{
"name": "discount",
"kind": "optional",
"type": "integer",
"description": "",
"example": 10
},
{
"name": "discount_type",
"kind": "optional",
"type": "integer",
"description": "`0` - fixed `1` - percentage\n",
"example": 0
},
{
"name": "enabled",
"kind": "optional",
"type": "boolean",
"description": "",
"example": true
}
]
},
{
"name": "address_meta_data",
"kind": "optional",
"type": "object",
"description": "",
"example": "",
"schema": [
{
"name": "zip_code",
"kind": "optional",
"type": "string",
"description": "",
"example": "123456"
},
{
"name": "city",
"kind": "optional",
"type": "string",
"description": "",
"example": "Palo Alto"
},
{
"name": "street",
"kind": "optional",
"type": "string",
"description": "",
"example": "Flowers St."
},
{
"name": "street_number",
"kind": "optional",
"type": "string",
"description": "",
"example": "1990"
},
{
"name": "region",
"kind": "optional",
"type": "string",
"description": "",
"example": "California"
},
{
"name": "region_short_code",
"kind": "optional",
"type": "string",
"description": "",
"example": "CA"
},
{
"name": "country_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 6
},
{
"name": "latitude",
"kind": "optional",
"type": "string",
"description": "",
"example": "37.4419"
},
{
"name": "longitude",
"kind": "optional",
"type": "string",
"description": "",
"example": "122.1430"
},
{
"name": "address_2",
"kind": "optional",
"type": "string",
"description": "",
"example": ""
}
]
},
{
"name": "current_client_id",
"kind": "optional",
"type": "integer",
"description": "",
"example": 30
}
]
},
{
"name": "links",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/links",
"customType": "links",
"schema": []
},
{
"name": "meta",
"kind": "optional",
"type": "object",
"description": "",
"modelRef": "#/paths/~1api~1v1~1pets/get/responses/200/content/application~1json/schema/properties/meta",
"customType": "meta",
"schema": []
}
],
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "example-0-curl",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url /api/v1/pet-parents \\\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/pet-parents\", 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/pet-parents\")\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/pet-parents\"\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 \"name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"+19772480544\",\n \"secondary_phone\": \"+19772480544\",\n \"chatUid\": \"cjfiem-c9hg-apzm-23sod\",\n \"has_app\": true,\n \"has_app_date\": \"2020-06-12 15:45:43\",\n \"enable_chat_without_app\": false,\n \"created_at\": \"2020-06-12 15:45:43\",\n \"updated_at\": \"2020-06-12 15:45:43\",\n \"address\": \"Flowers St. 300, Palo Alto, 123456, USA\",\n \"address_2\": \"\",\n \"city\": \"Buenos Aires\",\n \"birthdate\": \"1990-04-04\",\n \"observations\": \"happy\",\n \"cnp\": \"1234567890123\",\n \"chip_number\": \"99281028\",\n \"discounts\": [\n {\n \"id\": 10,\n \"name\": \"digitail disc10\",\n \"description\": \"digitail disc10\",\n \"discount\": 10,\n \"discount_type\": 0,\n \"enabled\": true\n }\n ],\n \"address_meta_data\": {\n \"zip_code\": \"123456\",\n \"city\": \"Palo Alto\",\n \"street\": \"Flowers St.\",\n \"street_number\": \"1990\",\n \"region\": \"California\",\n \"region_short_code\": \"CA\",\n \"country_id\": 6,\n \"latitude\": \"37.4419\",\n \"longitude\": \"122.1430\",\n \"address_2\": \"\"\n },\n \"current_client_id\": 30\n }\n ],\n \"links\": {},\n \"meta\": {}\n}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"text": ""
}
]
}