Checkmob icon

Checkmob

Interact with the Checkmob Field Service API v2

Group → List

AI-generated

Summary

Lists Checkmob groups, with optional filters and sorting, and can fetch one page or all available pages.

Inputs

  • Return All — When enabled, fetches pages until the API reports no more results. Otherwise, returns up to the Limit.
  • Limit — Maximum number of groups to return when Return All is off; defaults to 50. The API page size is capped at 100.
  • IDs — Comma-separated group IDs to filter by.
  • Search — Text to search for by group name or keyword.
  • Sort — Comma-separated sort fields; prefix a field with - for descending order. Allowed fields depend on the API.
  • Updated After — Only include groups updated after the specified date.
  • User IDs — Comma-separated user IDs; filters for groups containing those users.
  • Language — Sets the language used for API error messages. Defaults to Portuguese (Pt-BR); English (en-US) is also available.

Output shape

A list of group records.

With Return All disabled, returns up to the Limit (default 50); with it enabled, retrieves and concatenates pages. API list data is under dados; pagination metadata is under paginacao.

Links

Discussion