Scannable Docs
Concepts

Inspections

Read the inspections of your equipment, with checklist results, photos and PDFs.

An inspection (insp_…) is one recorded examination of an item. List them with List inspections and read one with Retrieve an inspection. Inspections need the inspections:read scope.

You see the inspections of every item in your inventory. An API key sees every item in your organisation; a member connected through OAuth sees the inspections of the items their role and folder permissions let them see.

An item's inspections from before your organisation began holding it keep their outcome and checklist results, but come back without who carried them out or their evidence: inspector, notes, each check's notes and attachments are empty. Filtering by inspector doesn't match them.

What an inspection carries

  • item: the item inspected, as { id, serial_number, name }. See Items.
  • status: the outcome, passed, failed, quarantined or monitoring.
  • type: thorough or general.
  • inspected_at: when it was carried out, or null if no date was recorded.
  • inspector: who carried it out, as { id, name }. id is the member's member_… identifier, or null when the inspector is not a member of your organisation, such as an outside inspector or someone who has since left. name is the name recorded with the inspection, set for outside inspectors too.
  • is_competent_inspector and notes.

inspector is null on a manufacturer's own inspection, and on one recorded without an inspector.

Retrieving one inspection also returns:

  • checklist: the checklist it was made against, or null. A manufacturer's checklist can't be retrieved from /v1/checklists, but its name and results are here.
  • results: the result of each check, in checklist order: passed, failed, repair, not_applicable or monitoring, with any notes.
  • attachments: its photos and PDFs. A PDF link works for an hour, until its expires_at, so download the file straight away rather than storing the link. A photo link doesn't expire.

Finding inspections

The list is newest first by inspected_at; inspections with no recorded date come last. Filter it by item_id (an item_… or serial_… identifier), status, type, inspector (a member_… identifier), inspected_after and inspected_before. status and type take several values, comma-separated, such as status=failed,quarantined.

The list pages by cursor, so inspections recorded while you page are never skipped or repeated. Pass each response's next_cursor as cursor, with the same filters, until it is null.

An identifier with the wrong prefix is rejected with validation_failed. One from another organisation returns an empty page.

On this page