Customer

Gets all contacts of a customer

get/core/latest/customers/{customer-id}/contacts

Request

Base URL: https://api.klara.ch
URL: https://api.klara.ch/core/latest/customers/{customer-id}/contacts
Auth: one of:
- API key in header X-API-KEY
- HTTP bearer

Path parameters

customer-idstring required

Example:1

Id of the customer to get all contacts from

Response

List of contacts

idstring

Id of this contact. Does not need to be included when creating CustomerContact

imageIdstring

Id of this contact's image. Does not need to be included when creating CustomerContact

salutation'MALE' | 'FEMALE' | 'MALE_FEMALE' | 'FAMILY'

Salutation for this contact

firstNamestring required

First name of this contact

lastNamestring required

Last name of this contact

emailstring

Email of this contact

websitestring

Website of this contact

additionalAddressDefinitionstring

Additional address definition of this contact

categoriesstring[]

Category list of this contact

functionstring

Function of this contact

birthdaystring date

Birth date of this person in ISO 8601 format (yyyy-mm-dd)

notestring

Note of this contact

Example response

[
  {
    "id": "1",
    "imageId": "1",
    "salutation": "MALE",
    "firstName": "John",
    "lastName": "Henry",
    "email": "john.henry@gmail.com",
    "website": "www.youtube.com",
    "phones": [
      {
        "id": "1",
        "phoneNumber": "+41783334444",
        "type": "PRIVATE"
      }
    ],
    "onlinePlatforms": [
      {
        "id": "1",
        "platformName": "FACEBOOK",
        "platformValue": "www.linkedin.com/abc"
      }
    ],
    "customFields": [
      {
        "id": "1",
        "customName": "name at home",
        "customValue": "John Henry"
      }
    ],
    "birthday": "2020-12-20",
    "note": "this is a important contact."
  }
]

Changes

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