Skip to main content

List Inspection Checklists

GET 

/api/repairs/inspection-templates

Lists inspection checklist templates.

Required scope: repairs:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Simple list (no pagination). Without any of page, per_page, filter, filter_groups or sort, the response is {"data": [...]} with every template, ordered by kind then name. Optional parameters for this mode:

  • kind — diagnosis or qc.
  • active_only (boolean) — only active (non-archived) templates.

Paginated list. Send any of page, per_page, filter[...], filter_groups or sort to get a standard paginated response (data, current_page, last_page, per_page, total, ...). Default 10 per page. Archived templates are hidden unless filter[archived] says otherwise. results_count (how many units have answers saved against the template) is filled in this mode.

Filters (paginated mode):

  • filter[archived] — empty/omitted = active only, only (or 1/true) = archived only, all = both.
  • filter[is_active] — true or false.
  • filter[search] — matches ID exactly or name partially.
  • Text filters filter[<field>][<operator>] on name, kind, applies_to (product, category, all), product_sku, product_category_name. Operators: is, is_not, contains, does_not_contain, starts_with, does_not_start_with, ends_with, does_not_end_with, is_one_of, is_not_one_of, is_empty, is_not_empty.
  • Numeric filters filter[<field>][<operator>] on id, product_id, product_category_id, items_count. Operators: is, is_not, greater_than, greater_than_or_equal, less_than, less_than_or_equal, between, is_empty, is_not_empty.
  • Date-time filters on created_at, updated_at (Y-m-d). Operators include is, before, after, on_or_before, on_or_after, between, today, yesterday, past_week, past_month, past_year, past_days, next_days.
  • filter_groups — a nested AND/OR tree of the same conditions, e.g. {"conjunction":"and","children":[{"type":"condition","condition":{"column":"kind","operator":"is","value":"qc"}}]}.

Sorts: id, name, kind, is_active, items_count, results_count, created_at, updated_at. Prefix with - for descending. Default: kind, then name.

Authentication: Bearer token with the repairs:read scope.

Request​

Responses​

OK

Response Headers
    Content-Type