Checkmob icon

Checkmob

Interact with the Checkmob Field Service API v2

Segment → List

AI-generated

Summary

Lists Checkmob segments, with optional filters and sorting. Set Return All to fetch every page, or use Limit to cap the results.

Inputs

  • Return All — Defaults to false. When enabled, fetches all available pages; otherwise the API page size is set from Limit, capped at 100 items.
  • Limit — Defaults to 50 and is shown when Return All is off. Sets the maximum number of results to return.
  • Active — Filter for all, active, or inactive segments; defaults to all.
  • IDs (Comma-Separated) — Optional comma-separated segment 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.
  • Updated After — Optional date and time filter for segments updated after the specified time.
  • Language — Selects the language for API error messages; defaults to Portuguese (Pt-BR), with English (en-US) also available.

Output shape

a list of segment records

With Return All off, returns up to Limit items (the API caps a page at 100). With Return All on, retrieves pages until the API reports no further pages or returns an empty page.

Links

Discussion