link

List animals for a Link customer

Lists active animals (not deceased, removed or marked duplicate) owned by the given Link customer, most recently updated first. Only the first 100 animals are returned and there is no pagination metadata; prefer the paginated /animals/page variant, which also supports a name filter.

get/workspaces/{workspaceId}/link/customers/{customerId}/animals

Request

Base URL
https://vetnio.com/api/v2
URL
https://vetnio.com/api/v2/workspaces/{workspaceId}/link/customers/{customerId}/animals
Auth
HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the clinic (workspace), as returned by GET /workspaces. The key's user must be a member of the clinic, or an admin of the organization it belongs to.

Example:furunculotic-loud-chihuahua

customerIdinteger required

Link customer (animal owner) id, as returned in customers[].id by the customer search endpoint.

Example:54967922

Response

Array of animals.

idinteger required

Link animal id. Pass it as animalId to the compatible-entries and export endpoints.

namestring required

Animal name from Link.

kindNamestring nullable required

Species name from Link (Link calls it kind), or null.

breedNamestring nullable required

Breed name from Link, or null.

genderNamestring nullable required

Sex name from Link, or null.

birthdatestring nullable required

Date of birth (YYYY-MM-DD) from Link, or null.

deceasedboolean required

Whether Link marks the animal as deceased. Only active animals are requested from Link, so this is normally false.

Example response

[
  {
    "id": 1234567,
    "name": "Bella",
    "kindName": "Hund",
    "breedName": "Labrador retriever",
    "genderName": "Tik",
    "birthdate": "2020-03-15"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.