Permissions needed: ACCESS_PATIENTS\nReturns list of Pets
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "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": "stringReturns only the pets updated after this datetime (exclusive). The value must be a UTC ISO 8601 timestamp with a Z suffix, for example 2020-08-16T08:56
.000000Z. Timezone offsets such as +02 are not accepted. Updated at and created at are returned in UTC in the response.", "format": "date-time" }, { "kind": "optional", "name": "filter[updated_to]", "type": "stringReturns only the pets updated at or before this datetime (inclusive). The value must be a UTC ISO 8601 timestamp with a Z suffix, for example 2020-08-16T08:56
.000000Z. Timezone offsets such as +02 are not accepted. Updated at and created at are returned in UTC in the response.", "format": "date-time" }, { "kind": "optional", "name": "filter[birthday_between]", "type": "string", "example": "2021-02-01,2021-02-29", "description": "Date range for pet birthday, format is 'YYYY-MM-DD,YYYY-MM-DD' (e.g. '2021-02-01,2021-02-29'). This will return pets born between the two dates.
" }, { "kind": "optional", "name": "include", "type": "string", "description": "Additional info to include. You can use multiple, comma separated. Options: species,breed,trupanionSpecies,trupanionBreed,crossBreed,owners,clinics,vetPetRequests.clinic,patients,patients.archiveType
" }, { "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": "per_page", "type": "integer", "description": "Number of items to retrieve per page", "default": 15 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "data", "kind": "optional", "type": "array", "description": "", "modelRef": "#/paths/~1api~1v1~1pets/post/responses/201/content/application~1json/schema/properties/data", "customType": "data[]", "schema": [] }, { "name": "links", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "first", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "last", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "https://digitail.test/api/v1/entities?page=10" }, { "name": "prev", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "" }, { "name": "next", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "https://digitail.test/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", "nullable": true, "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://digitail.test/api/v1/entities?page=1\",\"label\":\"1\",\"active\":true},{\"url\":\"https://digitail.test/api/v1/entities?page=2\",\"label\":\"Next »\",\"active\":true}]", "itemType": "object", "customType": "object[]", "schema": [ { "name": "url", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "« Previous" } ] }, { "name": "path", "kind": "optional", "type": "string", "description": "", "example": "https://digitail.test/api/v1/entities" }, { "name": "per_page", "kind": "optional", "type": "integer", "description": "", "example": 15 }, { "name": "to", "kind": "optional", "type": "integer", "nullable": true, "description": "", "example": 10 }, { "name": "total", "kind": "optional", "type": "integer", "description": "", "example": 145 } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "The request was invalid or contained data that was not allowed.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "message", "kind": "optional", "type": "string", "description": "", "example": "Requested filter(s) `filter1` are not allowed. Allowed filter(s) are date, query, ..." } ], "isExpanded": true } ] }, { "statusCode": "401", "description": "The authorization token is missing or invalid.", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "The user is not authorized to perform the requested operation.", "jsonExample": "", "isExpanded": true }, { "statusCode": "429", "description": "The user has sent too many requests in a given amount of time (\"rate limiting\"). Max 200 requests per minute.
", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "9Tab-hKEEyaIUdRZGOIaz", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://developer.digitail.io/api/v1/pets?filter[clinic_id]=integer&per_page=15' \\\n --header 'accept: application/json'" }, { "id": "SinjuwIz79wnTMPRqBscU", "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(\"https://developer.digitail.io/api/v1/pets?filter[clinic_id]=integer&per_page=15\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "5CPiSjVJuEW4uPEo1yFWk", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/pets?filter[clinic_id]=integer&per_page=15\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "s8BcHlZRFKmIHezL_siWT", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/pets?filter[clinic_id]=integer&per_page=15\"\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": "9Tab-hKEEyaIUdRZGOIaz" }, "results": { "languages": [ { "id": "92HhOrzGYvrMclOPitvGj", "language": "200", "code": "// Successful operation\n{\n \"data\": [\n \"\"\n ],\n \"links\": {\n \"first\": \"\",\n \"last\": \"https://digitail.test/api/v1/entities?page=10\",\n \"prev\": \"\",\n \"next\": \"https://digitail.test/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://digitail.test/api/v1/entities\",\n \"per_page\": 15,\n \"to\": 10,\n \"total\": 145\n }\n}" }, { "id": "1SCvXNotVmvtOIv90-SXN", "language": "400", "code": "// The request was invalid or contained data that was not allowed.\n{\n \"message\": \"Requested filter(s) `filter1` are not allowed. Allowed filter(s) are date, query, ...\"\n}" }, { "id": "g1_B4KTwaOshd3B7ln-2O", "language": "401", "code": "// The authorization token is missing or invalid.\n" }, { "id": "WujwUxNd-PwE9YAX3fTPN", "language": "403", "code": "// The user is not authorized to perform the requested operation.\n" }, { "id": "Yifx2uR15elSJ9YYd4EpZ", "language": "429", "code": "// The user has sent too many requests in a given amount of time (\"rate limiting\"). Max 200 requests per minute.\n" } ], "selectedLanguageId": "92HhOrzGYvrMclOPitvGj" } }, "children": [ { "text": "" } ] }