Contracts_GetContracts
GET
/contracts
Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/contracts?searchData.dealerNumber=undefined&searchData.contractNumber=undefined&searchData.customerName=undefined&searchData.customerPhoneNumber=undefined&searchData.last5or6or8orFullVIN=undefined&searchData.startDate=undefined&searchData.endDate=undefined&searchData.lastName=undefined&searchData.contractFullDetails=undefined&searchData.contractStatus=undefined&searchData.identifier=undefined&searchData.countRecords=undefined&searchData.ignoreCount=undefined&searchData.pageSize=undefined&searchData.page=undefined&searchData.maxPageSize=undefined' \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>'Response Response Example
{
"allowClaimSearchAPIPerformanceOn": true,
"indexResult": [
{
"coBuyer": {
"accountHolderType": "Invalid",
"billingAddress": {
"addressLine1": "string",
"addressLine2": "string",
"attentionTo": "string",
"city": "string",
"fax": "string",
"phoneExtension": "string",
"phoneNumber": "string",
"region": "string",
"zipCode": "string"
},
"businessName": "string",
"emailAddress": "string",
"emailOptIn": true,
"firstName": "string",
"id": 0,
"lastName": "string",
"name": "string",
"physicalAddress": {
"addressLine1": "string",
"addressLine2": "string",
"attentionTo": "string",
"city": "string",
"fax": "string",
"phoneExtension": "string",
"phoneNumber": "string",
"region": "string",
"zipCode": "string"
},
"uriReference": "string"
},
"contractStatus": "Invalid",
"coveredItems": {
"cubicCentimeterDisplacement": 0,
"cubicInchDisplacement": 0,
"cylinders": 0,
"driveType": "Invalid",
"fuelDelivery": "string",
"fuelType": "string",
"gvwr": 0,
"horsepower": 0,
"identifier": "string",
"liters": 0,
"make": "string",
"model": "string",
"numberOfEngines": 0,
"series": "string",
"tonRating": "string",
"trim": "string",
"vehicleType": "Invalid",
"vin": "string",
"year": 0
},
"coveredItemSuggestedRetailPrice": 0,
"customer": {
"accountHolderType": "Invalid",
"billingAddress": {
"addressLine1": "string",
"addressLine2": "string",
"attentionTo": "string",
"city": "string",
"fax": "string",
"phoneExtension": "string",
"phoneNumber": "string",
"region": "string",
"zipCode": "string"
},
"businessName": "string",
"emailAddress": "string",
"emailOptIn": true,
"firstName": "string",
"id": 0,
"lastName": "string",
"name": "string",
"physicalAddress": {
"addressLine1": "string",
"addressLine2": "string",
"attentionTo": "string",
"city": "string",
"fax": "string",
"phoneExtension": "string",
"phoneNumber": "string",
"region": "string",
"zipCode": "string"
},
"uriReference": "string"
},
"customFields": [
{
"customFieldId": 0,
"name": "string",
"type": "Invalid",
"value": "string"
}
],
"dateEffective": "2019-08-24T14:15:22.123Z",
"dealerCost": 0,
"dealerNumber": "string",
"deductibleCode": "string",
"enteredDate": "2019-08-24T14:15:22.123Z",
"expirationDate": "2019-08-24T14:15:22.123Z",
"expirationMiles": 0,
"externalUser": "string",
"financedAmount": 0,
"financedLength": 0,
"financeType": "Invalid",
"holds": [
{
"contractId": 0,
"holdType": "Invalid",
"id": 0,
"resolves": [
{
"holdId": 0,
"id": 0,
"remitAmount": 0
}
]
}
],
"id": 0,
"identifier": "string",
"inServiceDate": "2019-08-24T14:15:22.123Z",
"lienHolder": {
"accountHolderType": "Invalid",
"billingAddress": {
"addressLine1": "string",
"addressLine2": "string",
"attentionTo": "string",
"city": "string",
"fax": "string",
"phoneExtension": "string",
"phoneNumber": "string",
"region": "string",
"zipCode": "string"
},
"businessName": "string",
"emailAddress": "string",
"emailOptIn": true,
"firstName": "string",
"id": 0,
"lastName": "string",
"name": "string",
"physicalAddress": {
"addressLine1": "string",
"addressLine2": "string",
"attentionTo": "string",
"city": "string",
"fax": "string",
"phoneExtension": "string",
"phoneNumber": "string",
"region": "string",
"zipCode": "string"
},
"uriReference": "string"
},
"msrp": 0,
"number": "string",
"plan": {
"planCode": "string",
"planId": 0,
"planName": "string"
},
"primaryDeductibleAmount": 0,
"product": {
"claimSetting": {
"cccType": {
"id": 0,
"name": "string"
}
},
"productCode": "string",
"productId": 0,
"productName": "string"
},
"productType": "string",
"program": {
"programCode": "string",
"programId": 0,
"programName": "string"
},
"purchasePrice": 0,
"purchaseType": "Invalid",
"rateId": 0,
"rewardNumber": "string",
"secondaryDeductibleAmount": 0,
"seller": {
"accountHolderType": "Invalid",
"billingAddress": {
"addressLine1": "string",
"addressLine2": "string",
"attentionTo": "string",
"city": "string",
"fax": "string",
"phoneExtension": "string",
"phoneNumber": "string",
"region": "string",
"zipCode": "string"
},
"businessName": "string",
"emailAddress": "string",
"emailOptIn": true,
"firstName": "string",
"id": 0,
"lastName": "string",
"name": "string",
"physicalAddress": {
"addressLine1": "string",
"addressLine2": "string",
"attentionTo": "string",
"city": "string",
"fax": "string",
"phoneExtension": "string",
"phoneNumber": "string",
"region": "string",
"zipCode": "string"
},
"uriReference": "string"
},
"sellerCost": 0,
"surchargeCodes": [
"string"
],
"termMiles": 0,
"termMonths": 0,
"uriReference": "string",
"usageAtPurchase": 0,
"vehiclePurchaseDate": "2019-08-24T14:15:22.123Z",
"vehiclePurchasePrice": 0,
"vehiclePurchaseType": "Invalid"
}
],
"numberOfPages": 0,
"numberOfRecords": 0
}Modified at 2026-07-23 15:06:18