GET/api/partner/v1/cars/{carId}

Get car

Get one car.

Authorization

X-Api-Key header

Send your partner key on every request. The key is bound to exactly one owner account.

Path parameters

carIdstringpathrequired

Response

200 · application/json

successbooleanrequired

dataobject

idstring

externalIdstringnullable

Your own car id

titlestringnullable

carTypeIdstringnullable

carBrandstringnullable

carModelstringnullable

yearinteger

colorstringnullable

interiorColorstringnullable

vinstringnullable

plateNumberstringnullable

plateStatestringnullable

citystringnullable

statestringnullable

zipCodestringnullable

phoneNumberstringnullable

publishedboolean

priceDailynumber

priceWeeklynumber

priceMonthlynumber

priceSecurityDepositnumber

errorstringnullable

Status codes

200The car.

401Missing, unknown or revoked API key.

404The resource does not exist under this owner.

{ "success": true, "data": { "id": "CAR-1042", "externalId": "NJTP-9f2c41a8", "title": "Toyota Camry 2023", "carTypeId": "SEDAN", "carBrand": "Toyota", "carModel": "Camry", "year": 2023, "color": "Silver", "interiorColor": "Black", "vin": "4T1BF1FK5HU123456", "plateNumber": "K72LMX", "plateState": "NJ", "city": "Newark", "state": "NJ", "zipCode": "07102", "phoneNumber": "+12015550142", "published": true, "priceDaily": 79, "priceWeekly": 460, "priceMonthly": 1650, "priceSecurityDeposit": 300 }, "error": null }