List pets

Endpoints

GET List pets GET Get a pet

GET /pets

Try it

Returns a paginated collection of pets available to the authenticated KennelBooker business.

Filter the collection using the optional request.* query parameters documented below.

Send the business API key in the X-Api-Key header.

Example request

cURL

curl --request GET \
  --url "https://api.kennelbooker.com/api/v1/pets?request.species=dog&request.page=1&request.pageSize=25" \
  --header "X-Api-Key: kb_live_your_api_key" \
  --header "Accept: application/json"

using System.Net.Http;
using System.Net.Http.Headers;

using (var client = new HttpClient())
{
    client.DefaultRequestHeaders.Add(
        "X-Api-Key",
        "kb_live_your_api_key");

    client.DefaultRequestHeaders.Accept.Add(
        new MediaTypeWithQualityHeaderValue("application/json"));

    HttpResponseMessage response = await client.GetAsync(
        "https://api.kennelbooker.com/api/v1/pets?request.species=dog&request.page=1&request.pageSize=25");

    response.EnsureSuccessStatusCode();
    string json = await response.Content.ReadAsStringAsync();
}

JavaScript

const response = await fetch("https://api.kennelbooker.com/api/v1/pets?request.species=dog&request.page=1&request.pageSize=25", {
  method: "GET",
  headers: {
    "X-Api-Key": "kb_live_your_api_key",
    "Accept": "application/json"
  }
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const result = await response.json();

Request contract

Pet query parameters

Every query parameter is optional. Parameter names include the request. prefix used by the API model binder.

Property	Type	Example	Description
`request.search`	`string`	`Poppy`	Applies the endpoint's free-text pet search.
`request.customerId`	`integer`	`165`	Returns pets belonging to one customer.
`request.species`	`string`	`dog`	Filters pets by species.
`request.breed`	`string`	`Affenpinscher`	Filters pets by breed.
`request.page`	`integer`	`1`	The one-based page number.
`request.pageSize`	`integer`	`25`	The requested number of pets per page.

Response envelope

Property	Type	Example	Description
`page`	`integer`	`1`	The one-based page returned.
`pageSize`	`integer`	`1`	The applied page size.
`totalRecords`	`integer`	`84`	The total number of matching pets.
`totalPages`	`integer`	`84`	The number of available pages.
`items`	`array`	`[...]`	The pets returned for the current page.

Pet fields items[]

Property	Type	Example	Description
`petId`	`integer`	`56008`	The pet identifier.
`kennelId`	`integer`	`1`	The KennelBooker business identifier.
`customerId`	`integer`	`42268`	The owning customer identifier.
`petTypeId`	`integer`	`1`	The pet type identifier.
`petType`	`string`	`dog`	The pet type or species.
`breedId`	`integer`	`73`	The breed identifier.
`breed`	`string`	`Affenpinscher`	The breed name.
`name`	`string`	`Poppy`	The pet name.
`tempPetId`	`integer`	`-1`	The temporary pet identifier when present.
`sex`	`string`	`female`	The pet's sex.
`registration`	`string`		The registration value.
`microchip`	`string`		The microchip value.
`spayed`	`string`	`yes`	The spayed or neutered value.
`weight`	`string`	`12 kgs`	The recorded weight.
`dietaryRequirements`	`string`		General dietary requirements.
`dietaryRequirementsAm`	`string`		Morning dietary requirements.
`dietaryRequirementsNoon`	`string`		Midday dietary requirements.
`dietaryRequirementsPm`	`string`		Evening dietary requirements.
`medication`	`string`		Primary medication instructions.
`medication2`	`string`		Additional medication instructions.
`medication3`	`string`		Additional medication instructions.
`medication4`	`string`		Additional medication instructions.
`medication5`	`string`		Additional medication instructions.
`medicationNoon`	`string`		Primary midday medication instructions.
`medicationPm`	`string`		Primary evening medication instructions.
`medication2Noon`	`string`		Medication 2 midday instructions.
`medication2Pm`	`string`		Medication 2 evening instructions.
`medication3Noon`	`string`		Medication 3 midday instructions.
`medication3Pm`	`string`		Medication 3 evening instructions.
`medication4Noon`	`string`		Medication 4 midday instructions.
`medication4Pm`	`string`		Medication 4 evening instructions.
`medication5Noon`	`string`		Medication 5 midday instructions.
`medication5Pm`	`string`		Medication 5 evening instructions.
`notes`	`string`		General pet notes.
`photo`	`string`		The pet photo value.
`crossBreed`	`boolean`	`false`	Whether the pet is a cross-breed.
`colour`	`string`	`Black`	The pet colour.
`archived`	`boolean`	`false`	Whether the pet is archived.
`insurer`	`string`		The insurer name.
`medicalNotes`	`string`		Medical notes.
`passport`	`string`		The pet passport value.
`createdDate`	`date-time`	`2017-11-25T23:58:12Z`	The pet creation date in UTC.
`insurerNumber`	`string`		The insurance policy number.
`evaluationComplete`	`integer`	`0`	The evaluation completion value.
`evaluationCompleteNotes`	`string`		Evaluation notes.
`allergies`	`string`		Recorded allergies.
`groomingNotes`	`string`		Grooming notes.
`deleted`	`boolean`	`false`	Whether the pet is deleted.

Responses

200

OK application/json

Response body

{
  "page": 1,
  "pageSize": 1,
  "totalRecords": 84,
  "totalPages": 84,
  "items": [
    {
      "petId": 56008,
      "kennelId": 1,
      "customerId": 42268,
      "petTypeId": 1,
      "petType": "dog",
      "breedId": 73,
      "breed": "Affenpinscher",
      "name": "Poppy",
      "sex": "female",
      "spayed": "yes",
      "weight": "12 kgs",
      "crossBreed": false,
      "archived": false,
      "createdDate": "2017-11-25T23:58:12Z",
      "evaluationComplete": 0,
      "deleted": false
    }
  ]
}

401

Missing or invalid API key application/json

Public examples use sanitized pet values and shorten the object for readability. The field table documents every property present in the confirmed response.