Checkmob icon

Checkmob

Interact with the Checkmob Field Service API v2

User → List

AI-generated

Summary

Lists Checkmob users, with optional filters and sorting. Returns either one page up to the specified limit or all available pages.

Inputs

  • Return All — When enabled, fetches all pages. Defaults to false.
  • Limit — Maximum number of users to return when Return All is off; defaults to 50. The API page size is capped at 100.
  • Active — Filter for all users, active users, or inactive users; defaults to All.
  • Group IDs (Comma-Separated) — Filter by comma-separated group IDs.
  • IDs (Comma-Separated) — Filter by comma-separated user IDs.
  • Profile ID — Filter by profile ID; defaults to 0.
  • Search — Search users using the supplied text.
  • Sort — Comma-separated sort fields; prefix a field with - for descending order. Valid field names depend on the API.
  • Language — Selects Portuguese (pt-BR) or English (en-US) for API error messages; defaults to Portuguese.

Output shape

A list of user records

Return All fetches pages and combines their dados entries. Otherwise, the response contains up to the requested limit, subject to the API's 100-item page cap.

Links

Discussion