Sign in
latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Pets

List all Pets

Permissions needed: ACCESS_PATIENTS Returns list of Pets

get/api/v1/pets

Query parameters

filter[clinic_id]integer required

ID of the clinic from where the entity was created

filter[vet_id]integer

Id of the vet that performed/owns the entity

filter[owner_id]integer
Example:1

Id of the related PetParent

filter[id]integer

Pet ID

filter[nickname]string

Pet nickname

filter[updated_from]string date-time

Updated after the datetime (use iso8601 format - 2020-08-16T08:56:44.000000Z). Updated at and created at are returned in UTC in the response

filter[updated_to]string date-time

Updated at less or equal than the datetime (use iso8601 format - 2020-08-16T08:56:44.000000Z). Updated at and created at are returned in UTC in the response

filter[birthday_between]string
Example:2021-02-01,2021-02-29

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.

includestring

Additional info to include. You can use multiple, comma separated. Options: species,breed,trupanionSpecies,trupanionBreed,crossBreed,owners,clinics,vetPetRequests.clinic,patients,patients.archiveType

sortstring

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

per_pageinteger

Number of items to retrieve per page

Parameters

#/paths/~1api~1v1~1tags/get/parameters/5 — unresolved $ref

Response

Successful operation

dataData[] — unresolved $ref