Checkmob icon

Checkmob

Interact with the Checkmob Field Service API v2

Category → List

AI-generated

Summary

Lists Checkmob categories, optionally filtering and sorting the results. Use Return All to fetch every available page, or set a page limit for a smaller result set.

Inputs

  • Return All — Defaults to false. When enabled, retrieves categories across pages; otherwise, returns up to the configured Limit.
  • Limit — Maximum number of categories to return when Return All is disabled; defaults to 50 and must be at least 1.
  • IDs (Comma-Separated) — Filter by category IDs, entered as a comma-separated list.
  • Search — Filter by text matching a name or keyword.
  • Sort — Comma-separated sort fields; prefix a field with - for descending order. Valid fields depend on the API.
  • Source — Filter categories by their source/origin identifier.
  • Updated After — Filter for records updated after the specified date, for incremental synchronization.
  • Language — Select the language for API error messages; defaults to Portuguese (Pt-BR), with English (en-US) also available.

Output shape

A list of category records.

The operation uses Checkmob's paginated list endpoint. With Return All enabled, it concatenates records from available pages; otherwise, it requests a single page sized to the limit, capped at 100 per page.

Examples

Example 1: List categories with a limit

Set Return All to false and optionally adjust Limit; the default limit is 50.

Example 2: Retrieve all categories

Set Return All to true to fetch and combine all available pages.

Example 3: Filter or sort categories

Use Additional Fields to supply IDs, Search, Sort, Source, or Updated After criteria.

Links

Discussion