Scannable Docs
Concepts

Checklists

Read your inspection checklists and the checks on each.

A checklist (chk_…) is a list of checks an inspector works through. List your checklists with List checklists and read one with Retrieve a checklist. Checklists need the checklists:read scope.

These are your organisation's own checklists. A manufacturer can also provide checklists for its products; those aren't listed and can't be retrieved here, but an inspection made against one still shows the checklist's name and every result. See Inspections.

What a checklist carries

  • name, description and published. Filter the list with published=true or published=false.
  • updated_at: when the checklist or any of its checks last changed.

Retrieving one checklist also returns criteria: its checks in order, each with a title, an optional description and an order.

On this page