Checkmob icon

Checkmob

Interact with the Checkmob Field Service API v2

Checklist → List

AI-generated

Summary

Lists Checkmob checklists, with optional filters and sorting. Choose whether to fetch every page or cap the results with a limit.

Inputs

  • Return All — Defaults to false. When enabled, fetches pages until the API reports no further pages; otherwise, returns up to the Limit.
  • Limit — Defaults to 50 and is shown when Return All is false. Sets the maximum number of results; the API fetches at most 100 per page.
  • Active — Filter for all, active, or inactive checklists; defaults to All.
  • Effective On — Return only checklists effective on the specified date.
  • IDs (Comma-Separated) — Optional comma-separated checklist IDs to filter by.
  • Search — Optional search term.
  • Sort — Optional comma-separated fields to sort by. Prefix a field with '-' for descending order; valid fields depend on the API.
  • Language — Selects the language for API error messages; defaults to Portuguese (Pt-BR).

Output shape

A list of checklist records.

Return All retrieves available pages; otherwise, the result is capped by Limit. Invalid sort fields may produce an API error listing valid fields.

Links

Discussion