getLinkedCustomer
getLinkedCustomer
Path Parameters
serviceSubscriberDepartmentToken string required
entity string required
entityId int64 required
Responses
- 200
 - 204
 - 400
 - 401
 - 500
 
OK
application/json
Schema
Example (from schema)
Schema
- Array [
 - ]
 - Array [
 - ]
 - Array [
 - ]
 - Array [
 - ]
 - Array [
 - ]
 - Array [
 - ]
 
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
customerWithVehicles object
customer object
id int64
customerKey string
firstName string
middleName string
lastName string
company string
preferredLocale string
emails object[]
emailAddress string
label string
okToEmail boolean
isPreferred boolean
comments string
phoneNumbers object[]
phoneNumber string
label string
okToCall boolean
okToText boolean
isPreferred boolean
comments string
preferredCommunication string
bestTimeToContact object
startTime string
endTime string
addresses object[]
line1 string
line2 string
city string
zip string
addressType string
type string
Possible values: [COMMON, PRIMARY, BILLING, OTHER]
country string
updateTS date-time
uuid string
isValid boolean
isPreferred boolean
state string
availability int32
isBusiness boolean
customerUuid string
customerId string
vehicles object[]
id int64
vin string
vehicleKey string
isValid boolean
imageUrl string
brandId int64
licensePlate string
color string
vehicleModel string
vehicleYear string
vehicleTrim string
vehicleUuid string
vehicleEngine string
estimatedMileage string
vehicleMake string
{
  "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-10-30T17:04:36.788Z",
          "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"
      }
    ]
  }
}
No Content
*/*
Schema
Example (from schema)
Schema
- Array [
 - ]
 - Array [
 - ]
 
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}
Bad Request
*/*
Schema
Example (from schema)
Schema
- Array [
 - ]
 - Array [
 - ]
 
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}
Unauthorized
*/*
Schema
Example (from schema)
Schema
- Array [
 - ]
 - Array [
 - ]
 
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}
Internal Server Error
*/*
Schema
Example (from schema)
Schema
- Array [
 - ]
 - Array [
 - ]
 
errors object[]
errorCode int32
errorTitle string
errorMessage string
warnings object[]
warningCode int32
warningTitle string
warningMessage string
{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}
Loading...