Skip to main content
API resource

Customers

Access customer profiles, communication preferences, pets and bookings.

GET /customers/{customerId}

Get a customer

Try it

Returns one customer belonging to the authenticated KennelBooker business.

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

Request contract

Path parameter

The customer must belong to the business identified by the supplied API key.

Parameter Type Required Description
customerId integer Required The unique customer identifier.

Customer fields customer

Property Type Example Description
customerId integer 165 The customer identifier.
firstname string Example The customer's first name.
secondname string Customer The customer's surname.
email string customer@example.com The primary email address.
secondContact_Firstname string Jamie The second contact's first name.
secondContact_Lastname string Customer The second contact's surname.
emailSecondary string secondary@example.com The secondary email address.
landline string 01 555 0100 The landline number.
mobile string 087 555 0100 The mobile number.
mobileCountry string +353 The mobile country dialling code.
workPhone string 01 555 0101 The work phone number.
address string 1 Example Street The combined address value.
address1 string 1 Example Street Address line 1.
address2 string Example Town Address line 2.
address3 string Dublin Address line 3.
address4 string Ireland Address line 4.
zipCode string D01 ABC2 The postal or ZIP code.
archived boolean false Whether the customer is archived.
emergencyContactName string Emergency Contact The emergency contact name.
emergencyContactAddress string 2 Example Street The emergency contact address.
emergencyContactPhone string 087 555 0102 The emergency contact phone number.
emergencyContactEmail string emergency@example.com The emergency contact email.
createdDate date-time 2021-10-03T16:45:52Z The customer creation date in UTC.
pets array [...] Pets returned with the customer.

Communication preference fields

These booleans describe the customer’s current communication consent settings.

Property Type Example Description
email_Accepts boolean true General email consent.
email_Accepts_Receipts boolean true Email receipt consent.
email_Accepts_Marketing boolean true Email marketing consent.
email_Accepts_Booking_Reminders boolean true Email booking reminder consent.
smS_Accepts boolean true General SMS consent.
smS_Accepts_Marketing boolean true SMS marketing consent.
smS_Accepts_Booking_Reminders boolean true SMS booking reminder consent.
smS_Accepts_Booking_Price_Messages boolean true SMS booking price message consent.
pushMessage_Accepts_Booking_Confirmations boolean true Push booking confirmation consent.
pushMessage_Accepts_Booking_Reminders boolean true Push booking reminder consent.
pushMessage_Accepts_Booking_Receipts boolean true Push booking receipt consent.
pushMessage_Accepts_Booking_Price_Due boolean true Push booking price-due consent.
pushMessage_Accepts_Marketing boolean true Push marketing consent.
pushMessage_Accepts_Postcards boolean true Push postcard consent.
pushMessage_Accepts_Direct_Messages boolean true Push direct-message consent.

Pet fields pets[]

Property Type Example Description
petId integer 7180 The pet identifier.
kennelId integer 1 The KennelBooker business identifier.
customerId integer 165 The owning customer identifier.
petTypeId integer 1 The pet type identifier.
petType string dog The pet type.
breedId integer 13 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 2016-06-21T09:26:38Z The pet creation date in UTC.
insurerNumber string The insurance policy number.
evaluationComplete integer 1 The evaluation completion value.
evaluationCompleteDate date-time 2025-08-14T00:00:00Z The evaluation completion date when present.
evaluationCompleteNotes string Evaluation notes.
allergies string Recorded allergies.
groomingNotes string Grooming notes.
deleted boolean false Whether the pet is deleted.

Response

200
OK application/json
Response body
{
  "customerId": 165,
  "firstname": "Example",
  "secondname": "Customer",
  "email": "customer@example.com",
  "mobile": "087 555 0100",
  "mobileCountry": "+353",
  "address": "1 Example Street, Dublin",
  "archived": false,
  "createdDate": "2021-10-03T16:45:52Z",
  "email_Accepts": true,
  "smS_Accepts": true,
  "pushMessage_Accepts_Booking_Confirmations": true,
  "pets": [
    {
      "petId": 7180,
      "customerId": 165,
      "petType": "dog",
      "breed": "Affenpinscher",
      "name": "Poppy",
      "archived": false,
      "deleted": false
    }
  ]
}

Public examples use sanitized values. The list example is shortened to one customer and a representative subset of fields.