How to read a customer

This document is designed to help you understand how you can read a particular customer. The endpoint enables user to get details of a speicifc customer. To read a customer , you first need your credentials. If you don't already have one, head over to the Authentication and Authorization page to see how you can request for credentials from us.

Parameters Used

Path parameters

Parameter Name	Value	Description	Required
`departmentUUID`	`String`	Unique identifier of dealer department	Yes
`customerUUID`	`String`	Unique identifier of customer	Yes

Request parameters

Parameter Name	Description	Required	Default Value
`{{excludeVehicles}}`	Boolean operator to indicate whether to include the list of vehicles in the response. Use `true` to exclude vehicles and `false` to include them.	No	false

Authorization

Parameter Name	Description	Required
`{{basic_auth_token}}`	Authorization: Base64 encoded string using Service Subscriber Username and password	Yes

Scope

This request requires the following authorization scopes:

Scope	Level	Description
`customer.search`	`DealerDepartment`	Authorises client to fetch customers provided dealer department

Endpoint

curl -X GET "https://api.mykaarma.com/customer/v2/department/{{departmentUUID}}/customer/{{customerUUID}}"
-H "accept: application/json" 
-H "Authorization: {{basic_auth_token}}"

Response

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "customerWithVehicles": {
    "customer": {
      "id": 0,
      "customerKey": "string",
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "company": "string",
      "preferredLocale": "string",
      "emails": [
        {
          "emailAddress": "string",
          "label": "string",
          "okToEmail": true,
          "isPreferred": true,
          "comments": "string"
        }
      ],
      "phoneNumbers": [
        {
          "phoneNumber": "string",
          "label": "string",
          "okToCall": true,
          "okToText": true,
          "isPreferred": true,
          "comments": "string"
        }
      ],
      "preferredCommunication": "string",
      "bestTimeToContact": {
        "startTime": "string",
        "endTime": "string"
      },
      "addresses": [
        {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "zip": "string",
          "addressType": "string",
          "type": "COMMON",
          "country": "string",
          "updateTS": "2025-02-07T06:15:11.849Z",
          "uuid": "string",
          "isValid": true,
          "isPreferred": true,
          "state": "string"
        }
      ],
      "availability": 0,
      "isBusiness": true,
      "customerUuid": "string",
      "customerId": "string"
    },
    "vehicles": [
      {
        "id": 0,
        "vin": "string",
        "vehicleKey": "string",
        "isValid": true,
        "imageUrl": "string",
        "brandId": 0,
        "licensePlate": "string",
        "color": "string",
        "vehicleModel": "string",
        "vehicleYear": "string",
        "vehicleTrim": "string",
        "vehicleUuid": "string",
        "vehicleEngine": "string",
        "estimatedMileage": "string",
        "vehicleMake": "string"
      }
    ]
  }
}

Quick summary of getCustomer response fields

Parameter Name	Description
`id`	Unique identifier used by mykaarma to uniquely identify each customer in mykaarma databases. This value should not be used by vendor and in near future would always be null
`firstName`	fisr name of the customer
`middleName`	middle name of the customer
`lastName`	last name of the customer
`preferredLocale`	Customer's preferred language or locale.
`isBusiness`	boolean indicating whether the cusotmer is business customer or not.
`customerKey`	Unique identifier used by DMS to uniquely identify each customer, used by mykaarma to lookup customers in DMS databases for various purposes like update, delete, book appointment
`customerUuid`	Unique identifier used by mykaarma used for uniquely identifying customers over API calls(for read, write, update, delete purposes)
`company`	company name of the customer provided if the customer is a BUSINESS customer
`dealerId`	Unique identifier used by mykaarma to uniquely identify each dealer in mykaarma databases This value should not be used by and vendor and in near future would always be null
`addresses.type`	Enum with possible values `COMMON, PRIMARY, BILLING` which tells type of address. `COMMON`: Used when the primary and billing addresses are the same. `PRIMARY`: Represents the customer's home address. `BILLING`: Represents the customer's business address. Recommended: `PRIMARY`.
`addresses.addressType`	Indicates the type of address: use `P` for PRIMARY/COMMON type and `B` for BILLING type.
`addresses.line1`	The first line of the customer's address.
`addresses.line2`	The second line of the customer's address, often used for apartment or suite numbers.
`addresses.zip`	The postal code for the customer's address.
`addresses.country`	The country of the customer's address.
`addresses.isValid`	Boolean indicating if the address is valid.
`addresses.isPreferred`	Boolean indicating if this is the customer's preferred address.
`addresses.state`	The state or region of the customer's address.
`emails.emailAddress`	The customer's email address.
`emails.label`	Describes the type of email (e.g., personal, work).
`emails.okToEmail`	Boolean indicating if it's permissible to send emails to this address. Allowed values true/false.
`emails.isPreferred`	Boolean indicating if this is the customer's preferred email address. Allowed values true/false.
`phoneNumbers.phoneNumber`	The customer's phone number, prefixed with +1 for the country code.
`phoneNumbers.label`	Describes the type of email (e.g., cell,home,work ).
`phoneNumbers.okToCall`	Boolean indicating if it's permissible to call this number. Allowed values true/false.
`phoneNumbers.okToText`	Boolean indicating if it's permissible to send text messages to this number. Allowed values true/false.
`vehicles.id`	Unique identifier used by mykaarma to uniquely identify each vehicle in mykaarma databases. This value should not be used by and vendor and in near future would always be null
`vehicles.vehicleKey`	Unique identifier used by DMS to uniquely identify each vehicle, used by mykaarma to lookup vehicles in DMS databases for various purposes like updation, deletion, booking appointment etc.
`vehicles.vehicleUuid`	Unique identifier used by mykaarma in addition to `vehicles.id`, used for uniquely identifying vehicles over API calls(for read, write, update, delete purposes) without revealing their database id that is `vehicles.id`
`vehicles.vehicleYear`	the year when the vehicle was manufactured
`vehicles.vehicleMake`	the brand of the vehicle
`vehicles.estimatedMileage`	the esitmated mileage of the vehicle
`vehicles.vehicleEngine`	engine description of the vehicle
`vehicles.vehicleTrim`	trim description of the vehicle
`vehicles.vehicleModel`	model of the vehicle
`vehicles.vin`	VIN of the vehicle
`vehicles.isValid`	Indicates whether the customer currently owns the vehicle.
`errors.errorCode`	Numeric code representing the specific error.
`errors.errorTitle`	Short title describing the error.
`errors.errorMessage`	Detailed message explaining the error.
`warnings.warningCode`	Numeric code representing the specific warning.
`warnings.errorTitle`	Short title describing the warning.
`warnings.warningMessage`	Detailed message explaining the warning.

Parameters Used​

Path parameters​

Request parameters​

Authorization​

Scope​

Endpoint​

Response​

Quick summary of getCustomer response fields​