query_all
Automatically paginate through query results to collect up to a specified number of records, handling skip/take internally.
Instructions
Auto-paginate a query and return up to max_records records. Read-only.
Convenience over query_records: instead of you managing skip/take,
this loops through pages (each capped at 1000 by the API) until it has
max_records, the result set is exhausted, or the QUERY_ALL_HARD_CAP
safety ceiling is hit. Because every page is a request against the
ORG-WIDE rate budget, keep max_records as small as the task needs and
prefer a precise groups filter. The response includes a rate_limit
snapshot so you can see remaining budget after the sweep.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| groups | No | Filter groups (same structure/value-shape rules as query_records): [{"conditions": [{"parameter", "operator", "value"}, ...]}]. Conditions within a group are AND-ed; groups are OR-ed. Multi-value ops use `values`: [...]; Between uses `value` + `secondaryValue`; unknown `parameter` names are rejected. | |
| sort_by | No | Field to sort by. | |
| page_size | No | Records per page request (max 1000). | |
| descending | No | Sort descending. | |
| full_detail | No | Use full-detail variant (Contact/Gift only). | |
| max_records | No | Stop after collecting this many records (hard cap 10000). | |
| object_type | Yes | Object type to query, e.g. 'Contact' or 'Gift'. |