Checkmob icon

Checkmob

Interact with the Checkmob Field Service API v2

Travel → List Routes

AI-generated

Summary

Lists travel routes for a specified user and travel day, with optional date filters and sorting. Returns routes from the Checkmob API, either up to the configured limit or across all pages.

Inputs

  • Return All — Defaults to false. When false, the node requests up to the Limit; when true, it fetches all available pages.
  • Limit — Maximum number of routes to return when Return All is false; defaults to 50.
  • User ID (required) — The actual Checkmob user ID. The API rejects 0 or an empty value.
  • Day ID (required) — The actual travel day ID, obtained from List Days. The API rejects 0 or an empty value.
  • Additional Fields: End Date — Optional end date for filtering routes.
  • Additional Fields: Sort — Optional comma-separated sort fields; prefix a field with - for descending order. Valid fields depend on the API, which reports an error for unknown names.
  • Additional Fields: Start Date — Optional start date for filtering routes.
  • Language — Selects Portuguese (Pt-BR) or English (en-US) for API error messages; defaults to Portuguese.

Output shape

A list of route items.

Return All fetches pages until no further pages are reported; otherwise the node requests up to Limit items. The API response contains route data in dados with pagination metadata under paginacao.

Links

Discussion