Sign in
latestOpenAPI 3.0.02026-08-081413373.1 KB

8fb62eeae60e

openrecalls

get/openrecalls/{vin}

Path parameters

vinstring required

Vehicle Identification Number

Example:1HGCM82633A123456

Query parameters

makestring

Override make from VIN decode

modelstring

Override model from VIN decode

recalls'true' | 'false'

When set to true, the response includes an additional recalls array carrying the full make/model/year recall catalog (the same payload /recalls/{vin} returns in its data field) alongside the open-only data array. Useful when callers want both open campaigns for the VIN and the vehicle's full historical recall record in a single round trip.

yearstring

Override year from VIN decode

Response

Success

examplesobject

Navigation links to related resources.

openRecallsnumber required

Number of open recalls — equals data.length.

{"stackTrail":"paths:/openrecalls/{vin}:get:responses:200:content:application/json:schema:properties:retrievedAt","oasType":"schema","type":"unknown","description":"ISO 8601 timestamp of when the returned recall data was fetched from upstream. Recall data is cached until the next daily refresh, so this is how you tell how current the answer is; pass `?skipCache=true` to force a fresh fetch. `null` when the answer wasn't sourced from a cacheable upstream."}
statusstring required

Human-readable summary, e.g. "1 Open Recall" or "No Open Recalls".

totalRecallsnumber required

Total campaigns issued for this year/make/model, including ones already remedied for this VIN, so it can exceed openRecalls.