getCustomersListMinimal

getCustomersListMinimal

Path Parameters

serviceSubscriberDepartmentToken string required

Query Parameters

searchTerm string required
searchPreference string
maxResults int32
queryOperator string
fieldsToBeSearched string

Responses

• 200
• 204
• 400
• 401
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
matchingCustomers object[]
Array [
id int64
fname string
lname string
customerKey string
uuid string
company string
dealerId int64
communications object[]
Array [
commValue string
commType string
commLabel string
preferred boolean
id int64
]
vehicles object[]
Array [
model string
year string
make string
engine string
bodyStyle string
trim string
vin string
id int64
isValid boolean
uuid string
vehicleKey string
imageUrl string
]
secondaryCustomerData object[]
Array [
fname string
lname string
customerKey string
guid string
customerId int64
]
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "matchingCustomers": [
    {
      "id": 0,
      "fname": "string",
      "lname": "string",
      "customerKey": "string",
      "uuid": "string",
      "company": "string",
      "dealerId": 0,
      "communications": [
        {
          "commValue": "string",
          "commType": "string",
          "commLabel": "string",
          "preferred": true,
          "id": 0
        }
      ],
      "vehicles": [
        {
          "model": "string",
          "year": "string",
          "make": "string",
          "engine": "string",
          "bodyStyle": "string",
          "trim": "string",
          "vin": "string",
          "id": 0,
          "isValid": true,
          "uuid": "string",
          "vehicleKey": "string",
          "imageUrl": "string"
        }
      ],
      "secondaryCustomerData": [
        {
          "fname": "string",
          "lname": "string",
          "customerKey": "string",
          "guid": "string",
          "customerId": 0
        }
      ]
    }
  ]
}

No Content

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
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

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
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

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
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

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ]
}

GET /v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal

Request

Base URL

/customer

serviceSubscriberDepartmentToken — path required

searchTerm — query required

searchPreference — query

maxResults — query

queryOperator — query

fieldsToBeSearched — query

Accept

application/json*/*

curl / cURL

curl -L -X GET '/customer/v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal' \
-H 'Accept: application/json'

python / requests

curl -L -X GET '/customer/v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal' \
-H 'Accept: application/json'

go / native

curl -L -X GET '/customer/v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET '/customer/v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET '/customer/v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET '/customer/v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET '/customer/v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET '/customer/v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET '/customer/v2/department/:serviceSubscriberDepartmentToken/customer/listMinimal' \
-H 'Accept: application/json'