VEvetnio
link

List a page of animals for a Link customer

Lists one page of active animals (not deceased, removed or marked duplicate) owned by the given Link customer, optionally filtered by a partial animal name. Vetnio checks Link's paging metadata and fails with 500 rather than return an inconsistent page.

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

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/link/customers/{customerId}/animals/page
  • 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

Query parameters

namestring

Optional partial, case-insensitive match on the animal name, applied by Link. Leading and trailing whitespace is ignored.

Example:Bel
pageinteger

1-based page number.

Example:1
perPageinteger

Animals per page, 1 to 100.

Example:100

Response

Paginated animal results.

totalinteger required

Total number of matching animals across all pages.

pageinteger required

The page that was returned (1-based).

perPageinteger required

Page size used.

hasNextPageboolean required

true when more animals exist after this page.

Example response

{
  "animals": [
    {
      "id": 1234567,
      "name": "Bella",
      "kindName": "Hund",
      "breedName": "Labrador retriever",
      "genderName": "Tik",
      "birthdate": "2020-03-15"
    }
  ],
  "total": 2,
  "page": 1,
  "perPage": 100
}

Changes

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