query_records
Query Virtuous CRM object types with filters, sorting, and pagination. Enables read-only bulk data retrieval for Contact, Gift, and more.
Instructions
Run a read-only bulk query against a Virtuous object type. Read-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Records to skip (pagination). | |
| take | No | Records to return (max 1000). | |
| groups | No | Filter groups: [{"conditions": [{"parameter", "operator", "value"}, ...]}]. Conditions within a group are AND-ed; groups are OR-ed. Omit/empty for all records. VALUE SHAPE (auto-normalized, but get it right): single-value ops use `value`; multi-value ops (In/NotIn/IsAnyOf/IsNoneOf) use `values`: [a, b, ...]; range ops (Between/NotBetween) use `value` + `secondaryValue` (a 2-item list is auto-split). `parameter` MUST be an exact name from get_query_options — unknown names are rejected (Virtuous would otherwise silently ignore them and return everything). | |
| sort_by | No | Field to sort by. | |
| descending | No | Sort descending. | |
| full_detail | No | Use full-detail variant (Contact/Gift only). | |
| object_type | Yes | Object type to query, e.g. 'Contact' or 'Gift'. |