Query records
virtuous_queryRun a Virtuous query-builder query against one record type (contacts, gifts, campaigns, projects, tasks, grants, pledges, recurring gifts, events ...). Conditions use parameter/operator names from virtuous_get_query_options. Returns { list, total }. For Contact and Gift, full_details returns full records instead of the abbreviated view. Virtuous: POST /api//Query.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Records to skip (default 0). | |
| take | No | Records to return, 1-1000 (default 10). | |
| groups | No | Condition groups, as in the Virtuous query builder. Omit for all records. | |
| sort_by | No | Field to sort by (e.g. for gifts: Id, Amount, GiftDate, ReceiptDate, Batch). | |
| resource | Yes | Which Virtuous record type to query. | |
| descending | No | Sort descending. | |
| full_details | No | Contact and Gift only: return full records (Query/FullContact, Query/FullGift). | |
| include_archived | No | Contact queries only: include archived contacts. |