Servers Playground How we check Submit a server

Virtuous MCP by usefulapi

Working · 827 ms

io.usefulapi/virtuous-crmv1.18.0 Domain verified

Search donors and contacts, giving history, notes and projects, and log notes, tags and gifts.

Sales & CRM

Source Website Registry entry

Try it

Call this server's tools from your browser. Nothing to install.

https://virtuous-crm.usefulapi.io/mcp

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

virtuous_add_contact_tag

Apply an existing tag to a contact (find the tagId with virtuous_list_tags). Virtuous: POST /api/ContactTag.

tag_idinteger, required

The tag id (integer).

contact_idinteger, required

The contact id (integer).

The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.

I understand, run it anyway

Virtuous MCP by usefulapi MCP server | mcptry

Tools (21)

virtuous_add_contact_tag

Apply an existing tag to a contact (find the tagId with virtuous_list_tags). Virtuous: POST /api/ContactTag.

destructive

Argument	Type	Description
tag_id*	integer	The tag id (integer).
contact_id*	integer	The contact id (integer).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id",
    "tag_id"
  ],
  "properties": {
    "tag_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The tag id (integer).",
      "exclusiveMinimum": 0
    },
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The contact id (integer).",
      "exclusiveMinimum": 0
    }
  }
}

virtuous_create_contact_note

Add a note to a contact's timeline — a call, meeting, visit or other touchpoint. Writes to the donor record. Get the valid type names from virtuous_list_contact_note_types first. Virtuous: POST /api/ContactNote.

destructive

Argument	Type	Description
note*	string	The note text.
type	string	The note type, exactly as virtuous_list_contact_note_types returns it (e.g. Call). Virtuous rejects other names.
private	boolean	Make the note private.
important	boolean	Flag the note as important.
contact_id*	integer	The contact id (integer).
time_spent	integer	Time spent, in minutes.
note_date_time	string	When it happened, ISO 8601 (defaults to now).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id",
    "note"
  ],
  "properties": {
    "note": {
      "type": "string",
      "minLength": 1,
      "description": "The note text."
    },
    "type": {
      "type": "string",
      "description": "The note type, exactly as virtuous_list_contact_note_types returns it (e.g. Call). Virtuous rejects other names."
    },
    "private": {
      "type": "boolean",
      "description": "Make the note private."
    },
    "important": {
      "type": "boolean",
      "description": "Flag the note as important."
    },
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The contact id (integer).",
      "exclusiveMinimum": 0
    },
    "time_spent": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Time spent, in minutes."
    },
    "note_date_time": {
      "type": "string",
      "description": "When it happened, ISO 8601 (defaults to now)."
    }
  }
}

virtuous_create_contact_transaction

Submit a new or updated contact through Virtuous's import pipeline (the recommended way to add contacts). It is matched against existing contacts by name, email, phone, address and reference, bundled into an import at midnight, and only committed when a user reviews the import and clicks Run — so nothing is created in real time and no duplicates are forced. Virtuous: POST /api/Contact/Transaction.

destructive

Argument	Type	Description
city	string
name	string	Contact (household/organization) name.
tags	string	Tag names to apply (Virtuous takes these as one string).
email	string
phone	string
state	string
title	string	Name prefix, e.g. Mr., Dr.
postal	string
suffix	string

virtuous_create_gift_transaction

Record a gift (donation already received) through Virtuous's gift import pipeline — the method Virtuous recommends. The gift is matched to a contact, recurring gift or pledge, held until the nightly import, and only created when a user reviews the import and clicks Run. This records a gift; it does NOT charge anyone. Identify the donor with contact.id, contact.referenceId, or name/email details. Virtuous: POST /api/v2/Gift/Transaction.

destructive

Argument	Type	Description
batch	string	Batch name.
notes	string
amount*	string	Gift amount, e.g. "100.00".
contact*	object	The donor. Virtuous matches this against existing contacts.
segment	string	Segment code the gift is attributed to.
frequency	string	For a recurring gift: its frequency as named in Virtuous.
gift_date*	string	Gift date, e.g. 2026-09-29.
gift_type*

virtuous_find_contact

Look up a single contact by email address, or by an external reference (reference source + id, e.g. Stripe customer id). Give either email, or both reference_source and reference_id; if both are given Virtuous prioritises the reference. Virtuous: GET /api/Contact/Find.

read-only

Argument	Type	Description
email	string	The email address.
reference_id	string	The identifier within that reference source.
reference_source	string	The reference source, e.g. Stripe, MailChimp, Shopify.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address."
    },
    "reference_id": {
      "type": "string",
      "description": "The identifier within that reference source."
    },
    "reference_source": {
      "type": "string",
      "description": "The reference source, e.g. Stripe, MailChimp, Shopify."
    }
  }
}

virtuous_get_contact

Fetch one contact (household, organization, foundation ...) with its address, giving summary (life-to-date, year-to-date, last gift), individuals and their contact methods, and custom fields. Virtuous: GET /api/Contact/{contactId}.

read-only

Argument	Type	Description
contact_id*	integer	The contact id (integer).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id"
  ],
  "properties": {
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The contact id (integer).",
      "exclusiveMinimum": 0
    }
  }
}

virtuous_get_current_organization

Fetch the Virtuous organization this API key acts in — its name, time zone and culture, and whether the key's user is an administrator. A cheap way to confirm the key works. Virtuous: GET /api/Organization/Current.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

virtuous_get_gift

Fetch one gift in full: contact, type, date, amount and currency, batch, segment, grant, tribute, receipt date, designations to projects, premiums and custom fields. Virtuous: GET /api/Gift/{giftId}.

read-only

Argument	Type	Description
gift_id*	integer	The gift id (integer).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "gift_id"
  ],
  "properties": {
    "gift_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The gift id (integer).",
      "exclusiveMinimum": 0
    }
  }
}

virtuous_get_project

Fetch one project: code, type, status, balances, financial need, date range, life-to-date and calendar-year giving and gift/giver counts. Virtuous: GET /api/Project/{projectId}.

read-only

Argument	Type	Description
project_id*	integer	The project id (integer).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "project_id"
  ],
  "properties": {
    "project_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The project id (integer).",
      "exclusiveMinimum": 0
    }
  }
}

virtuous_get_query_options

List the parameters, their types, allowed operators and value options that virtuous_query accepts for one record type. Call this BEFORE building a query. Virtuous: GET /api/<Resource>/QueryOptions.

read-only

Argument	Type	Description
resource*	string	Which Virtuous record type to query.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "resource"
  ],
  "properties": {
    "resource": {
      "enum": [
        "Contact",
        "ContactIndividual",
        "ContactNote",
        "Gift",
        "GiftDesignation",
        "GiftAsk",
        "PlannedGift",
        "Pledge",
        "Premium",
        "RecurringGift",
        "Campaign",
        "Communication",
        "Project",
        "Event",
        "EventAttendee",
        "Grant",
        "Task"
      ],
      "type": "string",
      "description": "Which Virtuous record type to query."
    }
  }
}

virtuous_list_contact_gifts

List a contact's giving history: gift id, type, date, amount, segment and batch. Use virtuous_get_gift for designations and full detail. Virtuous: GET /api/Gift/ByContact/{contactId}.

read-only

Argument	Type	Description
skip	integer	Records to skip (default 0).
take	integer	Records to return, 1-100 (default 10).
sort_by	string	Sort field.
contact_id*	integer	The contact id (integer).
descending	boolean	Sort descending.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id"
  ],
  "properties": {
    "skip": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Records to skip (default 0)."
    },
    "take": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records to return, 1-100 (default 10)."
    },
    "sort_by": {
      "enum": [
        "Id",
        "GiftDate",
        "Amount",
        "Batch",
        "CreatedDateTime"
      ],
      "type": "string",
      "description": "Sort field."
    },
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The contact id (integer).",
      "exclusiveMinimum": 0
    },
    "descending": {
      "type": "boolean",
      "description": "Sort descending."
    }
  }
}

virtuous_list_contact_individuals

List the individuals (people) that belong to a contact/household, with names, birth dates, and their emails and phones (contact methods). Virtuous: GET /api/ContactIndividual/ByContact/{contactId}.

read-only

Argument	Type	Description
contact_id*	integer	The contact id (integer).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id"
  ],
  "properties": {
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The contact id (integer).",
      "exclusiveMinimum": 0
    }
  }
}

virtuous_list_contact_note_types

List the note types this organization accepts on a contact note (e.g. Call, Email, Visit; admins can add custom ones). Call it before virtuous_create_contact_note and pass one of these names as its type. Virtuous: GET /api/ContactNote/Types.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

virtuous_list_contact_notes

List the notes logged on a contact — calls, meetings, emails and other touchpoints — with type, date, text and author. Virtuous: GET /api/ContactNote/ByContact/{contactId}.

read-only

Argument	Type	Description
skip	integer	Records to skip (default 0).
take	integer	Records to return, 1-100 (default 10).
sort_by	string	Sort field.
contact_id*	integer	The contact id (integer).
descending	boolean	Sort descending.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id"
  ],
  "properties": {
    "skip": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Records to skip (default 0)."
    },
    "take": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records to return, 1-100 (default 10)."
    },
    "sort_by": {
      "enum": [
        "Id",
        "NoteDate",
        "CreatedDateTime"
      ],
      "type": "string",
      "description": "Sort field."
    },
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The contact id (integer).",
      "exclusiveMinimum": 0
    },
    "descending": {
      "type": "boolean",
      "description": "Sort descending."
    }
  }
}

virtuous_list_contact_tags

List the tags applied to a contact (contactTagId, tagId, name). Virtuous: GET /api/ContactTag/ByContact/{contactId}.

read-only

Argument	Type	Description
skip	integer	Records to skip (default 0).
take	integer	Records to return, 1-100 (default 10).
contact_id*	integer	The contact id (integer).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id"
  ],
  "properties": {
    "skip": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Records to skip (default 0)."
    },
    "take": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records to return, 1-100 (default 10)."
    },
    "contact_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "The contact id (integer).",
      "exclusiveMinimum": 0
    }
  }
}

virtuous_list_events

List the organization's events: name, type, location, start/end, invite and RSVP counts, attendance and total giving. Virtuous: GET /api/Event.

read-only

Argument	Type	Description
skip	integer	Records to skip (default 0).
take	integer	Records to return, 1-100 (default 10).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "skip": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Records to skip (default 0)."
    },
    "take": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records to return, 1-100 (default 10)."
    }
  }
}

virtuous_list_tags

List the organization's tags (id, name, tag group). Use this to find a tagId before virtuous_add_contact_tag. Virtuous: GET /api/Tag.

read-only

Argument	Type	Description
skip	integer	Records to skip (default 0).
take	integer	Records to return, 1-100 (default 10).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "skip": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Records to skip (default 0)."
    },
    "take": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records to return, 1-100 (default 10)."
    }
  }
}

virtuous_query

Run 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/<Resource>/Query.

read-only

Argument	Type	Description
skip	integer	Records to skip (default 0).
take	integer	Records to return, 1-1000 (default 10).
groups	array	Condition groups, as in the Virtuous query builder. Omit for all records.
sort_by	string	Field to sort by (e.g. for gifts: Id, Amount, GiftDate, ReceiptDate, Batch).
resource*	string	Which Virtuous record type to query.
descending	boolean	Sort descending.
full_details	boolean	Contact and Gift only: return full records (Query/FullContact, Query/FullGift).
include_archived	boolean

virtuous_search

Full-text search across contacts, individuals and entities (campaigns, projects, segments, tags) — the same search as the Virtuous search bar. Returns hits with highlights, grouped by kind. Virtuous: POST /api/Search.

read-only

Argument	Type	Description
skip	integer	Records to skip (default 0).
take	integer	Records to return, 1-100 (default 10).
query*	string	Free-text search, e.g. a name, email or organization.
filter_types	array	Restrict to these kinds. Omit to search all.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "query"
  ],
  "properties": {
    "skip": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Records to skip (default 0)."
    },
    "take": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records to return, 1-100 (default 10)."
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "description": "Free-text search, e.g. a name, email or organization."
    },
    "filter_types": {
      "type": "array",
      "items": {
        "enum": [
          "Contact",
          "Individual",
          "Campaign",
          "Project",
          "Segment",
          "Tag"
        ],
        "type": "string"
      },
      "description": "Restrict to these kinds. Omit to search all."
    }
  }
}

virtuous_search_contacts

Find contacts whose name, email, phone or address fully or partially matches a search string. Returns id, name, contact type, email, phone and address per match. Virtuous: POST /api/Contact/Search.

read-only

Argument	Type	Description
skip	integer	Records to skip (default 0).
take	integer	Records to return, 1-100 (default 10).
search*	string	Text to match, e.g. "Weyland" or an email address.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "search"
  ],
  "properties": {
    "skip": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Records to skip (default 0)."
    },
    "take": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records to return, 1-100 (default 10)."
    },
    "search": {
      "type": "string",
      "minLength": 1,
      "description": "Text to match, e.g. \"Weyland\" or an email address."
    }
  }
}

virtuous_search_projects

Find projects (funds / designations gifts are given to) by name or code, with their balances, financial need and life-to-date giving. Virtuous: POST /api/Project/Search.

read-only

Argument	Type	Description
skip	integer	Records to skip (default 0).
take	integer	Records to return, 1-100 (default 10).
search*	string	Text to match against project name or code.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "search"
  ],
  "properties": {
    "skip": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Records to skip (default 0)."
    },
    "take": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records to return, 1-100 (default 10)."
    },
    "search": {
      "type": "string",
      "minLength": 1,
      "description": "Text to match against project name or code."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "city": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "Contact (household/organization) name."
    },
    "tags": {
      "type": "string",
      "description": "Tag names to apply (Virtuous takes these as one string)."
    },
    "email": {
      "type": "string"
    },
    "phone": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "title": {
      "type": "string",
      "description": "Name prefix, e.g. Mr., Dr."
    },
    "postal": {
      "type": "string"
    },
    "suffix": {
      "type": "string"
    },
    "country": {
      "type": "string"
    },
    "address1": {
      "type": "string"
    },
    "address2": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "email_type": {
      "type": "string",
      "description": "Email type as configured in Virtuous (see contact method types)."
    },
    "first_name": {
      "type": "string"
    },
    "phone_type": {
      "type": "string",
      "description": "Phone type as configured in Virtuous (see contact method types)."
    },
    "email_lists": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Email list names to subscribe the contact to."
    },
    "middle_name": {
      "type": "string"
    },
    "contact_type": {
      "type": "string",
      "description": "Contact type, e.g. Household or Organization."
    },
    "reference_id": {
      "type": "string",
      "description": "The contact's id in that system."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field name -> value.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "reference_source": {
      "type": "string",
      "description": "Your system's name, e.g. \"Website\" or \"Stripe\"."
    },
    "origin_segment_code": {
      "type": "string",
      "description": "Code of the segment that brought this contact in."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "gift_date",
    "gift_type",
    "amount",
    "contact"
  ],
  "properties": {
    "batch": {
      "type": "string",
      "description": "Batch name."
    },
    "notes": {
      "type": "string"
    },
    "amount": {
      "type": "string",
      "minLength": 1,
      "description": "Gift amount, e.g. \"100.00\"."
    },
    "contact": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "maximum": 9007199254740991,
          "description": "Existing Virtuous contact id.",
          "exclusiveMinimum": 0
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "description": "Contact type, e.g. Household or Organization."
        },
        "email": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "suffix": {
          "type": "string"
        },
        "address": {
          "type": "object",
          "properties": {
            "city": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "postal": {
              "type": "string"
            },
            "country": {
              "type": "string"
            },
            "address1": {
              "type": "string"
            },
            "address2": {
              "type": "string"
            }
          }
        },
        "lastname": {
          "type": "string"
        },
        "emailType": {
          "type": "string"
        },
        "firstname": {
          "type": "string"
        },
        "phoneType": {
          "type": "string"
        },
        "middlename": {
          "type": "string"
        },
        "referenceId": {
          "type": "string",
          "description": "The donor's id in your system."
        }
      },
      "description": "The donor. Virtuous matches this against existing contacts."
    },
    "segment": {
      "type": "string",
      "description": "Segment code the gift is attributed to."
    },
    "frequency": {
      "type": "string",
      "description": "For a recurring gift: its frequency as named in Virtuous."
    },
    "gift_date": {
      "type": "string",
      "minLength": 1,
      "description": "Gift date, e.g. 2026-09-29."
    },
    "gift_type": {
      "type": "string",
      "minLength": 1,
      "description": "Gift type as configured in Virtuous, e.g. \"Cash\"."
    },
    "is_private": {
      "type": "boolean"
    },
    "check_number": {
      "type": "string"
    },
    "designations": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "amountDesignated"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "maximum": 9007199254740991,
            "description": "Project id.",
            "exclusiveMinimum": 0
          },
          "code": {
            "type": "string",
            "description": "Project code."
          },
          "name": {
            "type": "string",
            "description": "Project name."
          },
          "amountDesignated": {
            "type": "string",
            "description": "Amount designated to this project."
          }
        }
      },
      "description": "Split the gift across projects."
    },
    "receipt_date": {
      "type": "string"
    },
    "currency_code": {
      "type": "string",
      "description": "ISO currency code, e.g. USD."
    },
    "custom_fields": {
      "type": "object",
      "description": "Custom field name -> value.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": "string"
      }
    },
    "transaction_id": {
      "type": "string",
      "description": "The gift's id in that source (prevents double import)."
    },
    "is_tax_deductible": {
      "type": "boolean"
    },
    "transaction_source": {
      "type": "string",
      "description": "Where the gift came from, e.g. \"Website\"."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "resource"
  ],
  "properties": {
    "skip": {
      "type": "integer",
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Records to skip (default 0)."
    },
    "take": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records to return, 1-1000 (default 10)."
    },
    "groups": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "conditions"
        ],
        "properties": {
          "conditions": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "parameter",
                "operator"
              ],
              "properties": {
                "value": {
                  "type": "string",
                  "description": "The value to compare against (if the operator needs one)."
                },
                "values": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Several values, for operators that allow multiple values."
                },
                "operator": {
                  "type": "string",
                  "description": "An operator allowed for that parameter, from QueryOptions, e.g. \"Is\"."
                },
                "parameter": {
                  "type": "string",
                  "description": "A parameter name from the QueryOptions tool, e.g. \"Last Name\"."
                },
                "secondaryValue": {
                  "type": "string",
                  "description": "Second value, for range operators such as Between."
                }
              }
            },
            "minItems": 1
          }
        }
      },
      "description": "Condition groups, as in the Virtuous query builder. Omit for all records."
    },
    "sort_by": {
      "type": "string",
      "description": "Field to sort by (e.g. for gifts: Id, Amount, GiftDate, ReceiptDate, Batch)."
    },
    "resource": {
      "enum": [
        "Contact",
        "ContactIndividual",
        "ContactNote",
        "Gift",
        "GiftDesignation",
        "GiftAsk",
        "PlannedGift",
        "Pledge",
        "Premium",
        "RecurringGift",
        "Campaign",
        "Communication",
        "Project",
        "Event",
        "EventAttendee",
        "Grant",
        "Task"
      ],
      "type": "string",
      "description": "Which Virtuous record type to query."
    },
    "descending": {
      "type": "boolean",
      "description": "Sort descending."
    },
    "full_details": {
      "type": "boolean",
      "description": "Contact and Gift only: return full records (Query/FullContact, Query/FullGift)."
    },
    "include_archived": {
      "type": "boolean",
      "description": "Contact queries only: include archived contacts."
    }
  }
}