Actions75
- Category Actions
- Checklist Actions
- Checklist Answer Actions
- Client Actions
- Client Address Actions
- Client Note Actions
- Group Actions
- Market Sector Actions
- Objective Actions
- Person Actions
- Person Address Actions
- Record Actions
- Segment Actions
- Service Order Actions
- Service Status Actions
- Service Type Actions
- Step Actions
- Temperature Actions
- Travel Actions
- User Actions
Client → List
AI-generatedSummary
Lists Checkmob clients, with optional filters and sorting. Returns one page up to the configured limit or fetches all pages when Return All is enabled.
Inputs
- Return All — When enabled, fetches and combines all result pages. Defaults to false.
- Limit — Maximum number of clients to return when Return All is disabled; defaults to 50 and must be at least 1. The API page size is capped at 100.
- Additional Fields — Optional filters: client status (all, active, or inactive), category IDs, codes, creation date range, client IDs, market sector IDs, name/code/document text search, segment IDs, stage IDs, tax ID, temperature IDs, and updated-after date for incremental sync. ID and code lists are comma-separated. Sort accepts comma-separated field names, with a leading minus for descending order; valid fields depend on the API resource.
- Language — Language for API error messages: Portuguese (Pt-BR, default) or English (en-US).
Output shape
A list of client records
With Return All disabled, returns up to Limit records from one page. With Return All enabled, retrieves and combines pages until the API reports no more results or returns an empty page.