recalls

One campaign by recall ref

get/v2/recalls/{ref}

Request

  • Base URL: https://api.cardog.app
  • URL: https://api.cardog.app/v2/recalls/{ref}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

refstring required

A recall: ref. Slashes in refs must be URL-encoded (%2F).

Response

The campaign record

refstring required

Entity ref ({domain}:{key}) in the "recall" domain. Example: "recall:tc/2024-123"

authoritystring required

Issuing authority key: "tc" (Transport Canada) or "nhtsa". Other values may be added.

authorityLabelstring required

Display label, e.g. "Transport Canada"

campaignNumberstring required
componentstring nullable required
defectSummarystring nullable required
consequenceSummarystring nullable required
correctiveActionstring nullable required
recallDatestring nullable required

Date the recall was issued (ISO date, YYYY-MM-DD)

notificationTypestring nullable required
unitsAffectedinteger nullable required

Units affected by the whole campaign (the largest value across affects)

linksobject

Related resources, keyed by relation name, each a server-relative path. Example: {"recalls": "/v2/recalls/entity/model-year:toyota/rav4/2021"}

Changes

No recorded changes to this operation across all 1 revision of this API.