# Virtuous API Docs ## Docs - [Data Model Overview](https://docs.virtuous.org/analytics/data-model-overview.md): How all Virtuous CRM domains connect — a conceptual map of the full data model. - [Engagement Flow](https://docs.virtuous.org/analytics/engagement-flow.md): How campaigns, communications, segments, emails, and events connect to contacts and giving. - [Giving Flow](https://docs.virtuous.org/analytics/giving-flow.md): How a gift originates, what it is committed as, where it is directed, and how it is receipted. - [Campaign Attribution](https://docs.virtuous.org/analytics/reference/campaign-attribution.md): How a gift traces back through the campaign hierarchy — from Segment to Communication to Campaign. - [Campaigns](https://docs.virtuous.org/analytics/reference/campaigns.md): All tables in the campaigns hub — communications, segments, emails, sent emails, events, and segment statistics. - [Column Reference](https://docs.virtuous.org/analytics/reference/column-reference.md): Column conventions, key types, and a quick-reference grain table for all core CRM_RAW tables. - [Contact Profile](https://docs.virtuous.org/analytics/reference/contact-profile.md): The contact record and its related engagement data — individuals, notes, tasks, and receipts. - [Contacts](https://docs.virtuous.org/analytics/reference/contacts.md): All tables in the contacts hub — individuals, notes, tasks, memberships, segment statistics, and receipts. - [Core Gift Transaction](https://docs.virtuous.org/analytics/reference/gift-transaction.md): The tables involved in recording and analyzing a gift — from the contact who gave, through the gift record, to the project… - [Gifts](https://docs.virtuous.org/analytics/reference/gifts.md): All tables in the gifts hub — transactions, designations, commitments, batches, grants, tributes, and premiums. - [Lookup Values](https://docs.virtuous.org/analytics/reference/lookup-values.md): Valid codes and display labels for all TYPE_REFERENCES fields — the decode key for numeric status and type columns. - [Pledges & Gift Asks](https://docs.virtuous.org/analytics/reference/pledges.md): The commitment pipeline — from a gift ask through a pledge to the payments that fulfill it. - [Receipts](https://docs.virtuous.org/analytics/reference/receipts.md): All tables in the receipts hub — receipted gifts, receipting runs, statement runs, and sent emails. - [Recurring Giving](https://docs.virtuous.org/analytics/reference/recurring-giving.md): The three-table path from a recurring commitment to the individual gift transactions it generates. - [List Donor Activities](https://docs.virtuous.org/api-reference/activity/list-donor-activities.md): Get a paginated list of donor activities across the organization - [Get Token](https://docs.virtuous.org/api-reference/authentication/get-token.md) - [Get Campaign Query Options](https://docs.virtuous.org/api-reference/campaign/campaign-query-options.md) - [Create a Campaign](https://docs.virtuous.org/api-reference/campaign/create-a-campaign.md) - [Delete a Campaign](https://docs.virtuous.org/api-reference/campaign/delete-a-campaign.md) - [Get a Campaign](https://docs.virtuous.org/api-reference/campaign/get-a-campaign.md) - [Get Campaign](https://docs.virtuous.org/api-reference/campaign/get-by-id.md) - [Get Campaign Dependency Count](https://docs.virtuous.org/api-reference/campaign/get-campaign-dependency-count.md) - [Gets Campaign Steps](https://docs.virtuous.org/api-reference/campaign/gets-campaign-steps.md) - [List All Campaigns](https://docs.virtuous.org/api-reference/campaign/list-all-campaigns.md) - [Query Campaigns](https://docs.virtuous.org/api-reference/campaign/query-campaigns.md): To see which options can be sent, use the {M:Virtuous.WebApi.Controllers.CampaignController.QueryOptions} endpoint. If re… - [Replace a Campaign](https://docs.virtuous.org/api-reference/campaign/replace-a-campaign.md) - [Toggle Campaign Sync](https://docs.virtuous.org/api-reference/campaign/toggle-campaign-sync.md) - [Update a Campaign](https://docs.virtuous.org/api-reference/campaign/update-a-campaign.md) - [Campaigns](https://docs.virtuous.org/api-reference/campaigns.md) - [Get Campaign Details](https://docs.virtuous.org/api-reference/campaigns/get-campaign-details.md): Returns the full detail record for a single campaign, including its associated projects and their dates. The campaign must… - [List / Find Campaigns](https://docs.virtuous.org/api-reference/campaigns/list-find-campaigns.md): Returns a paginated list of all campaigns belonging to your organization family. Use this endpoint to sync campaign record… - [Get All Certifications](https://docs.virtuous.org/api-reference/certifications/get-all-certifications.md): Returns a paginated list of all certifications defined for your organization. Use this endpoint to sync certification reco… - [Communication Query Options](https://docs.virtuous.org/api-reference/communication/communication-query-options.md) - [Create Communication](https://docs.virtuous.org/api-reference/communication/create-communication.md) - [Get Communications for a Campaign](https://docs.virtuous.org/api-reference/communication/get-by-campaign-id.md) - [Get Communication](https://docs.virtuous.org/api-reference/communication/get-by-id.md) - [Get Channel Types](https://docs.virtuous.org/api-reference/communication/get-channel-types.md) - [Get Communication Types](https://docs.virtuous.org/api-reference/communication/get-communication-types.md) - [Query Communications](https://docs.virtuous.org/api-reference/communication/query-communications.md): To see which options can be sent, use the Communictation Query Options endpoint. If requests are timing out, you may be… - [Communications](https://docs.virtuous.org/api-reference/communications.md) - [Archive a Contact Address](https://docs.virtuous.org/api-reference/contact-address/archive-a-contact-address.md) - [Create a Contact Address](https://docs.virtuous.org/api-reference/contact-address/creates-a-new-contact-address.md) - [Delete a Contact Address](https://docs.virtuous.org/api-reference/contact-address/deletes-the-specified-contact-address.md) - [Get the Contact Addresses for a Contact](https://docs.virtuous.org/api-reference/contact-address/gets-the-contact-addresses-for-the-specified-contact.md) - [Get a Contact Address](https://docs.virtuous.org/api-reference/contact-address/gets-the-specified-contact-address.md) - [Unarchive a Contact Address](https://docs.virtuous.org/api-reference/contact-address/unarchive-a-contact-address.md) - [Update a Contact Address](https://docs.virtuous.org/api-reference/contact-address/updates-contact-address.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Create Collection for an Individual](https://docs.virtuous.org/api-reference/contact-individual/create-collection-for-an-individual.md) - [Create an Individual](https://docs.virtuous.org/api-reference/contact-individual/creates-a-new-individual.md) - [Delete Collection for an Individual](https://docs.virtuous.org/api-reference/contact-individual/delete-collection-for-an-individual.md) - [Delete an Individual](https://docs.virtuous.org/api-reference/contact-individual/deletes-the-specified-contact-individual.md) - [Find an individual by email address](https://docs.virtuous.org/api-reference/contact-individual/find-an-individual-by-email-address.md) - [Get Custom Collections for Individuals](https://docs.virtuous.org/api-reference/contact-individual/get-custom-collections-for-contact-individual-objects.md) - [Get Email Lists for an Individual](https://docs.virtuous.org/api-reference/contact-individual/get-email-lists-for-an-individual.md) - [Get an Individual](https://docs.virtuous.org/api-reference/contact-individual/gets-individual-by-id.md) - [Gets the avatar for a specified contact individual](https://docs.virtuous.org/api-reference/contact-individual/gets-the-avatar-for-a-specified-contact-individual.md) - [Gets the custom fields for contact individuals](https://docs.virtuous.org/api-reference/contact-individual/gets-the-custom-fields-for-contact-individuals.md): Will return all enabled custom fields available for the Contact Indvidual object. - [Get Individuals for a Contact](https://docs.virtuous.org/api-reference/contact-individual/gets-the-individuals-for-the-specified-contact.md) - [Query Individuals](https://docs.virtuous.org/api-reference/contact-individual/request-individuals-with-a-custom-query.md) - [Get Individual Query Options](https://docs.virtuous.org/api-reference/contact-individual/request-query-options-to-build-a-query-for-individuals.md) - [Update Collection for an Individual](https://docs.virtuous.org/api-reference/contact-individual/update-collection-for-an-individual.md) - [Update an Individual](https://docs.virtuous.org/api-reference/contact-individual/updates-a-contact-individual.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Upload the avatar for an Individual](https://docs.virtuous.org/api-reference/contact-individual/uploads-the-avatar-for-a-specified-contact-individual.md) - [Archive a Contact Method](https://docs.virtuous.org/api-reference/contact-method/archive-a-contact-method.md) - [Create a Contact Method for an Individual](https://docs.virtuous.org/api-reference/contact-method/create-a-new-contact-method-for-the-specified-contact-individual.md) - [Delete a Contact Method](https://docs.virtuous.org/api-reference/contact-method/deletes-the-specified-contact-method.md) - [Get a Contact Method](https://docs.virtuous.org/api-reference/contact-method/gets-the-specified-contact-method.md) - [Get Contact Method Types](https://docs.virtuous.org/api-reference/contact-method/gets-the-types-of-contact-methods.md) - [Get Contact Methods Types related to the Base Type](https://docs.virtuous.org/api-reference/contact-method/gets-the-types-of-contact-methods-related-to-the-specified-contact-method-type.md) - [Unarchive a Contact Method](https://docs.virtuous.org/api-reference/contact-method/unarchive-a-contact-method.md) - [Update a Contact Method](https://docs.virtuous.org/api-reference/contact-method/updates-a-contact-method.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Contact Methods](https://docs.virtuous.org/api-reference/contact-methods.md) - [Get Contact Note Query Options](https://docs.virtuous.org/api-reference/contact-note/contact-note-query-options.md): Returns all possible query options for Contact Notes. - [Create a Note for a Contact](https://docs.virtuous.org/api-reference/contact-note/creates-a-new-note-for-the-specified-contact.md) - [Delete a Note](https://docs.virtuous.org/api-reference/contact-note/deletes-the-specified-contact-note.md) - [Gets the custom fields for contact note](https://docs.virtuous.org/api-reference/contact-note/get-custom-fields-for-contact-notes.md): Will return all enabled custom fields available for the Contact Indvidual object. - [Get the Important Notes for a Contact](https://docs.virtuous.org/api-reference/contact-note/gets-the-important-notes-for-the-specified-contact.md) - [Get the Notes for a Contact](https://docs.virtuous.org/api-reference/contact-note/gets-the-notes-for-the-specified-contact.md) - [Get a Note](https://docs.virtuous.org/api-reference/contact-note/gets-the-specified-note.md) - [Get Contact Note Types](https://docs.virtuous.org/api-reference/contact-note/gets-the-types-of-contact-notes.md) - [Create a Note using an Email](https://docs.virtuous.org/api-reference/contact-note/posts-the-email-as-a-contact-note.md) - [Query Contact Notes](https://docs.virtuous.org/api-reference/contact-note/query-contact-notes.md): To see which options can be sent, use the {M:Virtuous.WebApi.Controllers.ContactNoteController.QueryOptions} endpoint. If… - [Update a Note](https://docs.virtuous.org/api-reference/contact-note/updates-a-contact-note.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Create a Contact Reference](https://docs.virtuous.org/api-reference/contact-reference/creates-the-contact-reference.md) - [Delete a Contact Reference](https://docs.virtuous.org/api-reference/contact-reference/deletes-the-specified-reference-source.md) - [Create a Contact Tag](https://docs.virtuous.org/api-reference/contact-tag/create-a-new-contact-tag-for-the-specified-contact.md) - [Delete a Contact Tag](https://docs.virtuous.org/api-reference/contact-tag/deletes-the-specified-contact-tag.md) - [Get Tags for a Contact](https://docs.virtuous.org/api-reference/contact-tag/gets-the-tags-for-the-specified-contact.md) - [Archive a Contact](https://docs.virtuous.org/api-reference/contact/archive-a-contact.md) - [Create a Contact Import that will be processed for changes and duplicates](https://docs.virtuous.org/api-reference/contact/create-a-contact-import-that-will-be-processed-for-changes-and-duplicates.md) - [Create a Contact that will go through the import process](https://docs.virtuous.org/api-reference/contact/create-a-contact-that-will-be-processed-for-an-import.md) - [Create a Contact](https://docs.virtuous.org/api-reference/contact/create-a-new-contact.md): Will not check for contact duplicates. - [Create Collection for a Contact](https://docs.virtuous.org/api-reference/contact/create-collection-for-a-contact.md) - [Delete Collection for a Contact](https://docs.virtuous.org/api-reference/contact/delete-collection-for-a-contact.md) - [Find a Contact by Email Address or Reference Source and ID](https://docs.virtuous.org/api-reference/contact/find-a-contact-by-email-address-or-reference-source-and-id.md): Either email addres *or* reference source and id are required. Providing both will prioritize the reference s… - [Find all Contacts that match, fully or partially, the given search parameters](https://docs.virtuous.org/api-reference/contact/find-all-contacts-that-match-fully-or-partially-the-given-search-parameters.md) - [Find all Contacts within a given proximity of a geocoordinate](https://docs.virtuous.org/api-reference/contact/find-all-contacts-within-a-given-proximity-of-a-geocoordinate.md) - [Get a Contact](https://docs.virtuous.org/api-reference/contact/get-contact-by-id.md) - [Get a Contact by Reference ID](https://docs.virtuous.org/api-reference/contact/get-contact-by-reference-id.md): HMAC Auth only. - [Get a Contact by Reference Source and ID](https://docs.virtuous.org/api-reference/contact/get-contact-by-reference-source-and-id.md) - [Get Contact Name Prefixes and Titles](https://docs.virtuous.org/api-reference/contact/get-contact-name-prefixestitles.md) - [Get Contact Types](https://docs.virtuous.org/api-reference/contact/get-contact-types.md): Default types include Household, Organization and Foundation. Configurable via CRM. - [Get Contacts by Tag ID](https://docs.virtuous.org/api-reference/contact/get-contacts-by-tag-id.md) - [Get Contact Custom Fields Available](https://docs.virtuous.org/api-reference/contact/get-custom-fields-for-contacts.md): Will return all enabled custom fields available for the Contact object. - [Get Receipt](https://docs.virtuous.org/api-reference/contact/get-receipt.md) - [Receipts](https://docs.virtuous.org/api-reference/contact/get-receipts.md) - [Get the Activity for the Contacts the current user is following](https://docs.virtuous.org/api-reference/contact/get-the-activity-for-the-contacts-the-user-is-following.md) - [Get the Contacts the current user is following](https://docs.virtuous.org/api-reference/contact/get-the-contacts-the-user-is-currently-following.md) - [Query Contacts with Abbreviated Details](https://docs.virtuous.org/api-reference/contact/request-contacts-with-a-custom-query.md) - [Query Contacts with Full Details](https://docs.virtuous.org/api-reference/contact/request-contacts-with-a-custom-query-1.md): Includes full contact details instead of an abbreviated contact. - [Get Contact Query Options](https://docs.virtuous.org/api-reference/contact/request-query-options-to-build-a-query-for-contacts.md) - [Unarchive a Contact](https://docs.virtuous.org/api-reference/contact/unarchive-a-contact.md) - [Update a Contact](https://docs.virtuous.org/api-reference/contact/update-an-existing-contact.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only u… - [Update Collection for a Contact](https://docs.virtuous.org/api-reference/contact/update-collection-for-a-contact.md) - [Follow or Unfollow a Contact for the current user](https://docs.virtuous.org/api-reference/contact/update-whether-the-user-is-following-a-contact.md) - [Contacts](https://docs.virtuous.org/api-reference/contacts.md): Contacts in Virtuous are your constituents, givers, prospects, partners -- anyone who has a relationship with your organiz… - [Create a Custom Field](https://docs.virtuous.org/api-reference/customfield/create-a-custom-field.md) - [Delete a Custom Field](https://docs.virtuous.org/api-reference/customfield/delete-a-custom-field.md) - [Get a Custom Field](https://docs.virtuous.org/api-reference/customfield/get-a-custom-field.md) - [Get Custom Field Dependency Count](https://docs.virtuous.org/api-reference/customfield/get-custom-field-dependency-count.md) - [List All Custom Fields](https://docs.virtuous.org/api-reference/customfield/list-all-custom-fields.md) - [Update a Custom Field](https://docs.virtuous.org/api-reference/customfield/update-a-custom-field.md) - [Archive a Donor](https://docs.virtuous.org/api-reference/donor/archive-a-donor.md) - [Create a Donor Activity](https://docs.virtuous.org/api-reference/donor/create-a-donor-activity.md) - [Create a Donor Address](https://docs.virtuous.org/api-reference/donor/create-a-donor-address.md) - [Create a Donor Contact Method](https://docs.virtuous.org/api-reference/donor/create-a-donor-contact-method.md) - [Create a Donor Email Address](https://docs.virtuous.org/api-reference/donor/create-a-donor-email-address.md) - [Create a Donor Phone Number](https://docs.virtuous.org/api-reference/donor/create-a-donor-phone-number.md) - [Delete a Donor Address](https://docs.virtuous.org/api-reference/donor/delete-a-donor-address.md) - [Delete a Donor Contact Method](https://docs.virtuous.org/api-reference/donor/delete-a-donor-contact-method.md) - [Generate Donor Donation Page](https://docs.virtuous.org/api-reference/donor/generate-donor-donation-page.md) - [Get a Donor](https://docs.virtuous.org/api-reference/donor/get-a-donor.md) - [Get a Donor Address](https://docs.virtuous.org/api-reference/donor/get-a-donor-address.md) - [Get a Donor Contact Method](https://docs.virtuous.org/api-reference/donor/get-a-donor-contact-method.md) - [Get apidonor responses](https://docs.virtuous.org/api-reference/donor/get-apidonor-responses.md) - [Get apidonorlist](https://docs.virtuous.org/api-reference/donor/get-apidonorlist.md) - [Get Donor Campaign Statistics](https://docs.virtuous.org/api-reference/donor/get-donor-campaign-statistics.md) - [Get Donor Motivation Statistics](https://docs.virtuous.org/api-reference/donor/get-donor-motivation-statistics.md) - [Get Donor Segment Statistics](https://docs.virtuous.org/api-reference/donor/get-donor-segment-statistics.md) - [List Donor Activities](https://docs.virtuous.org/api-reference/donor/list-donor-activities.md) - [List Donor Addresses](https://docs.virtuous.org/api-reference/donor/list-donor-addresses.md) - [List Donor Contact Methods](https://docs.virtuous.org/api-reference/donor/list-donor-contact-methods.md) - [List Donor Custom Fields](https://docs.virtuous.org/api-reference/donor/list-donor-custom-fields.md) - [List Donor Email Addresses](https://docs.virtuous.org/api-reference/donor/list-donor-email-addresses.md) - [List Donor Gifts](https://docs.virtuous.org/api-reference/donor/list-donor-gifts.md) - [List Donor Phone Numbers](https://docs.virtuous.org/api-reference/donor/list-donor-phone-numbers.md) - [List Donor Projects](https://docs.virtuous.org/api-reference/donor/list-donor-projects.md) - [List Donor Recurring Gifts](https://docs.virtuous.org/api-reference/donor/list-donor-recurring-gifts.md) - [Merge Donors](https://docs.virtuous.org/api-reference/donor/merge-donors.md) - [Partially Update a Donor](https://docs.virtuous.org/api-reference/donor/partially-update-a-donor.md): This endpoint performs a partial update of the donor record. Only fields that are provided (non-null) in the request will… - [Partially Update a Donor Address](https://docs.virtuous.org/api-reference/donor/partially-update-a-donor-address.md) - [Partially Update a Donor Contact Method](https://docs.virtuous.org/api-reference/donor/partially-update-a-donor-contact-method.md) - [Partially Update a Donor Email Address](https://docs.virtuous.org/api-reference/donor/partially-update-a-donor-email-address.md) - [Partially Update a Donor Phone Number](https://docs.virtuous.org/api-reference/donor/partially-update-a-donor-phone-number.md) - [Query Donors](https://docs.virtuous.org/api-reference/donor/query-donors.md): When `includeDetails=true`, the response includes all related entities (DonorAddresses, DonorContactMethods) similar to th… - [Search Donors](https://docs.virtuous.org/api-reference/donor/search-donors.md) - [Set Primary Donor Address](https://docs.virtuous.org/api-reference/donor/set-primary-donor-address.md) - [Set Primary Donor Contact Method](https://docs.virtuous.org/api-reference/donor/set-primary-donor-contact-method.md) - [Set Primary Donor Email Address](https://docs.virtuous.org/api-reference/donor/set-primary-donor-email-address.md) - [Set Primary Donor Phone Number](https://docs.virtuous.org/api-reference/donor/set-primary-donor-phone-number.md) - [Transfer a Donor Gift](https://docs.virtuous.org/api-reference/donor/transfer-a-donor-gift.md) - [Transfer a Donor Recurring Gift](https://docs.virtuous.org/api-reference/donor/transfer-a-donor-recurring-gift.md) - [Update a Donor](https://docs.virtuous.org/api-reference/donor/update-a-donor.md): This endpoint performs a full update of the donor record. All fields in the request will replace existing values. To updat… - [Update a Donor Address](https://docs.virtuous.org/api-reference/donor/update-a-donor-address.md) - [Update a Donor Contact Method](https://docs.virtuous.org/api-reference/donor/update-a-donor-contact-method.md) - [Update a Donor Email Address](https://docs.virtuous.org/api-reference/donor/update-a-donor-email-address.md) - [Update a Donor Phone Number](https://docs.virtuous.org/api-reference/donor/update-a-donor-phone-number.md) - [Update Donor Notes](https://docs.virtuous.org/api-reference/donor/update-donor-notes.md) - [Add Individuals to an Email List](https://docs.virtuous.org/api-reference/email-list/bulks-adds-individuals-to-email-lists.md): This endpoint places a message on a queue and will return an Accepted response. The message will then be picked up by th… - [Search for an Email List](https://docs.virtuous.org/api-reference/email-list/searches-the-email-lists.md) - [Get Emails](https://docs.virtuous.org/api-reference/email/get-the-emails-for-the-current-organization.md) - [Send an Email to a list of Contacts](https://docs.virtuous.org/api-reference/email/send-an-email-to-a-list-of-contacts.md) - [Get apiemaillistsearch](https://docs.virtuous.org/api-reference/emaillist/get-apiemaillistsearch.md) - [Get Event Attendee Custom Fields Available](https://docs.virtuous.org/api-reference/event-attendee/get-the-custom-fields-for-event-attendees.md) - [Query Event Attendees](https://docs.virtuous.org/api-reference/event-attendee/request-event-attendees-with-a-custom-query.md) - [Get Event Attendee Query Options](https://docs.virtuous.org/api-reference/event-attendee/request-query-options-to-build-a-query-for-event-attendees.md) - [Create an Event Attendee](https://docs.virtuous.org/api-reference/event/create-a-new-event-attendee.md) - [Create an Event](https://docs.virtuous.org/api-reference/event/creates-a-new-event-using-the-specified-post-model.md) - [Create an Event Contact](https://docs.virtuous.org/api-reference/event/creates-the-event-contact-for-the-event-with-the-specified-identifier-using-the-specified-post-model.md) - [Delete an Event Attendee](https://docs.virtuous.org/api-reference/event/delete-the-event-attendee.md) - [Delete an Event Contact](https://docs.virtuous.org/api-reference/event/deletes-the-event-contact-with-the-specified-identifier.md) - [Delete an Event](https://docs.virtuous.org/api-reference/event/deletes-the-event-with-the-specified-identifier.md) - [Get Event Attendees for an Event](https://docs.virtuous.org/api-reference/event/get-all-event-attendees-for-the-specified-event.md) - [Get an Event Attendee](https://docs.virtuous.org/api-reference/event/get-the-specified-event-attendee.md) - [Get Event Contacts for an Event](https://docs.virtuous.org/api-reference/event/gets-all-event-contacts-for-the-specified-event.md) - [Get Events](https://docs.virtuous.org/api-reference/event/gets-all-events-for-the-current-organization.md) - [Get Event Custom Fields Available](https://docs.virtuous.org/api-reference/event/gets-the-custom-fields-for-events.md) - [Get an Event Contact](https://docs.virtuous.org/api-reference/event/gets-the-event-contact-with-the-specified-identifier.md) - [Get an Event](https://docs.virtuous.org/api-reference/event/gets-the-event-with-the-specified-identifier.md) - [Get the Event Types](https://docs.virtuous.org/api-reference/event/gets-the-suggested-event-types.md) - [Query Events](https://docs.virtuous.org/api-reference/event/request-events-with-a-custom-query.md) - [Get Event Query Options](https://docs.virtuous.org/api-reference/event/request-query-options-to-build-a-query-for-events.md) - [Find an Event](https://docs.virtuous.org/api-reference/event/searches-for-events-that-match-the-specified-filter.md) - [Update an Event Attendee](https://docs.virtuous.org/api-reference/event/update-the-event-attendee.md) - [Update an Event](https://docs.virtuous.org/api-reference/event/updates-the-event-with-the-specified-identifier-using-the-details-of-the-specified-put-model.md) - [Get a Single Form Completion](https://docs.virtuous.org/api-reference/forms/get-a-single-form-completion.md): Returns the full detail record for a single form completion, including all field responses submitted by the volunteer. Use… - [Get All Completions for a Form](https://docs.virtuous.org/api-reference/forms/get-all-completions-for-a-form.md): Returns a paginated list of all completions for the specified form. Use this endpoint to pull volunteer responses, survey… - [Get All Forms](https://docs.virtuous.org/api-reference/forms/get-all-forms.md): Returns a paginated list of all forms for your organization. By default, archived (soft-deleted) forms are excluded; pass… - [Create a Gift Ask](https://docs.virtuous.org/api-reference/gift-ask/creates-a-new-gift-ask.md) - [Get Gift Ask Custom Fields Available](https://docs.virtuous.org/api-reference/gift-ask/get-the-custom-fields-available-for-gift-asks.md): Will return all enabled custom fields available for the Gift Ask object. - [Get Gift Asks for a Contact](https://docs.virtuous.org/api-reference/gift-ask/gets-the-gift-asks-for-the-specified-contact.md) - [Get the Gifts applied to a Gift Ask](https://docs.virtuous.org/api-reference/gift-ask/gets-the-gifts-applied-to-the-specified-gift-ask.md) - [Get a Gift Ask](https://docs.virtuous.org/api-reference/gift-ask/gets-the-specified-gift-ask.md) - [Query Gift Asks](https://docs.virtuous.org/api-reference/gift-ask/request-gift-asks-with-a-custom-query.md) - [Get Gift Ask Query Options](https://docs.virtuous.org/api-reference/gift-ask/request-query-options-to-build-a-query-for-gift-asks.md) - [Update a Gift Ask](https://docs.virtuous.org/api-reference/gift-ask/updates-a-gift-ask.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Get Gift Designation Query Options](https://docs.virtuous.org/api-reference/gift-designation/get-gift-designation-query-options.md) - [Query Gift Designations](https://docs.virtuous.org/api-reference/gift-designation/get-gift-designations-matching-the-query-criteria-provided.md): You can sort by Id, Amount, GiftDate, ReceiptDate and Batch. - [Create many Gifts *not recommended*](https://docs.virtuous.org/api-reference/gift/bulk-create-gifts-not-recommended.md): Bulk create up to 100 Gifts at a time. Please note that this endpoint creates gifts directly onto a contact record. Using… - [Update many Gifts](https://docs.virtuous.org/api-reference/gift/bulk-update-gifts.md): Use this endpoint anytime more than 1 gift is going to be updated. Please note that unlike other update endpoints this en… - [Create a Batch of Gift Transactions](https://docs.virtuous.org/api-reference/gift/create-a-batch-of-gift-transactions.md): HMAC or OAuth Auth valid. - [Create a Gift Transaction](https://docs.virtuous.org/api-reference/gift/create-a-gift-transaction.md): HMAC or OAuth Auth valid. This is the recommended way to create a gift. This ensures the gift is matched using the Virtuo… - [Create a Gift *not recommended*](https://docs.virtuous.org/api-reference/gift/create-gift-not-recommended.md): This endpoint creates a gift directly onto a contact record. Using this endpoint assumes you know the precise contact the… - [Create a Reversing Transaction](https://docs.virtuous.org/api-reference/gift/create-reversing-transaction.md): Creates a new reversing transaction and uses the gift identifier specified to negate the amount and splits applied. - [Delete a Gift](https://docs.virtuous.org/api-reference/gift/delete-a-gift.md) - [Delete a Gift](https://docs.virtuous.org/api-reference/gift/delete-a-gift-with-the-specified-identifier.md) - [Get a Gift](https://docs.virtuous.org/api-reference/gift/get-a-gift.md) - [Get a Gift](https://docs.virtuous.org/api-reference/gift/get-a-gift-by-the-identifier.md) - [Get a Gift by Transaction Source and ID](https://docs.virtuous.org/api-reference/gift/get-a-gift-by-the-transaction-source-and-identifier.md) - [Get apigiftlist](https://docs.virtuous.org/api-reference/gift/get-apigiftlist.md) - [Get Gift Query Options](https://docs.virtuous.org/api-reference/gift/get-gift-query-options.md) - [Get Gifts for a Contact by Reference ID](https://docs.virtuous.org/api-reference/gift/get-gifts-by-a-contact-reference-identifier.md): HMAC Auth only. - [Query Gifts with Abbreviated Details](https://docs.virtuous.org/api-reference/gift/get-gifts-matching-the-query-criteria-provided.md): You can sort by Id, Amount, GiftDate, ReceiptDate and Batch. - [Query Gifts with Full Details](https://docs.virtuous.org/api-reference/gift/get-gifts-matching-the-query-criteria-provided-with-all-gift-info.md): Returns the full gift info along with the query. This can cause performance issues. We recommend using the Gift Query end… - [Get Gifts for a Contact](https://docs.virtuous.org/api-reference/gift/get-gifts-with-the-specified-contact-identifier.md) - [Get Non-Cash Gift Types Available](https://docs.virtuous.org/api-reference/gift/get-non-cash-gift-types-available.md): Will return all enabled custom fields available for the Gift object. - [Get Passthrough Gifts for a Contact](https://docs.virtuous.org/api-reference/gift/get-passthrough-gifts-with-the-specified-contact-identifier.md) - [Get Gift Custom Fields Available](https://docs.virtuous.org/api-reference/gift/get-the-custom-fields-available-for-gifts.md): Will return all enabled custom fields available for the Gift object. - [List Gift Custom Fields](https://docs.virtuous.org/api-reference/gift/list-gift-custom-fields.md) - [Query Gifts](https://docs.virtuous.org/api-reference/gift/query-gifts.md): When `includeDetails=true`, the response includes all related entities (Donor, Gateway, Segment, etc.) similar to the GET… - [Refund a Gift](https://docs.virtuous.org/api-reference/gift/refund-a-gift.md) - [Update a Gift](https://docs.virtuous.org/api-reference/gift/update-a-gift-with-the-specified-identifier.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only u… - [Update Gift Notes](https://docs.virtuous.org/api-reference/gift/update-gift-notes.md) - [Gifts](https://docs.virtuous.org/api-reference/gifts.md) - [Create a Grant](https://docs.virtuous.org/api-reference/grant/creates-a-new-grant.md) - [Delete a Grant](https://docs.virtuous.org/api-reference/grant/deletes-a-grant.md) - [Get Grant Custom Fields Available](https://docs.virtuous.org/api-reference/grant/get-the-custom-fields-available-for-grants.md): Will return all enabled custom fields available for the Grant object. - [Get Grants for a Contact](https://docs.virtuous.org/api-reference/grant/gets-a-list-of-grants-by-a-contact-identifier.md) - [Get the Gifts applied to a Grant](https://docs.virtuous.org/api-reference/grant/gets-the-gifts-applied-to-the-specified-grant.md) - [Get Grant](https://docs.virtuous.org/api-reference/grant/gets-the-grant-by-the-grant-identifier.md) - [Get a Grant by Reference ID](https://docs.virtuous.org/api-reference/grant/gets-the-grant-by-the-reference-identifier.md) - [Query Grants](https://docs.virtuous.org/api-reference/grant/request-grants-with-a-custom-query.md) - [Get Grant Query Options](https://docs.virtuous.org/api-reference/grant/request-query-options-to-build-a-query-for-grants.md) - [Update a Grant](https://docs.virtuous.org/api-reference/grant/updates-a-grant.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Create New Group](https://docs.virtuous.org/api-reference/groups/create-new-group.md): Creates a new group within your organization. Supply a name for the group. Optionally provide created_by_user_id (the VOMO… - [Get a Group](https://docs.virtuous.org/api-reference/groups/get-a-group.md): Returns the full detail record for a single group, including its parent group and any direct child (sub)groups. Use this e… - [Get All Groups](https://docs.virtuous.org/api-reference/groups/get-all-groups.md): Returns a paginated list of all groups for your organization. Use this endpoint to sync group records into an external sys… - [Get Group Members](https://docs.virtuous.org/api-reference/groups/get-group-members.md): Returns a paginated list of all users who are members of the specified group. Use this endpoint to inspect current group m… - [Update a Group](https://docs.virtuous.org/api-reference/groups/update-a-group.md): Updates the properties of an existing group. You must supply at least the group name. Provide a parent_id to change the gr… - [Update a Group's Members](https://docs.virtuous.org/api-reference/groups/update-a-groups-members.md): Replaces the specified group's membership with exactly the set of user IDs provided. This is NOT additive: any current mem… - [Individuals](https://docs.virtuous.org/api-reference/individuals.md) - [Delete apimotivationcodegroup](https://docs.virtuous.org/api-reference/motivationcode/delete-apimotivationcodegroup.md) - [Get apimotivationcode](https://docs.virtuous.org/api-reference/motivationcode/get-apimotivationcode.md) - [Get apimotivationcodegroup](https://docs.virtuous.org/api-reference/motivationcode/get-apimotivationcodegroup.md) - [Get apimotivationcodegrouplist](https://docs.virtuous.org/api-reference/motivationcode/get-apimotivationcodegrouplist.md) - [Get apimotivationcodelist](https://docs.virtuous.org/api-reference/motivationcode/get-apimotivationcodelist.md) - [Post apimotivationcode](https://docs.virtuous.org/api-reference/motivationcode/post-apimotivationcode.md) - [Post apimotivationcodegroup](https://docs.virtuous.org/api-reference/motivationcode/post-apimotivationcodegroup.md) - [Put apimotivationcode](https://docs.virtuous.org/api-reference/motivationcode/put-apimotivationcode.md) - [Put apimotivationcodegroup](https://docs.virtuous.org/api-reference/motivationcode/put-apimotivationcodegroup.md) - [Assign a Contact to an Organization Group](https://docs.virtuous.org/api-reference/organization-group/assign-a-contact-to-the-organization-group.md) - [Get all Organization Groups](https://docs.virtuous.org/api-reference/organization-group/gets-all-the-organization-groups.md) - [Get Organization Groups for a Contact](https://docs.virtuous.org/api-reference/organization-group/gets-the-organization-group-by-contact-identifier.md) - [Get the Contacts in an Organization Group](https://docs.virtuous.org/api-reference/organization-group/gets-the-organization-group-contacts.md) - [Get an Organization Group](https://docs.virtuous.org/api-reference/organization-group/gets-the-organization-group-with-the-specified-identifier.md) - [Remove a Contact from an Organization Group](https://docs.virtuous.org/api-reference/organization-group/unassigns-the-contact-from-the-organization-group.md) - [Get the Organizations the current user belongs to](https://docs.virtuous.org/api-reference/organization/gets-organizations-the-user-belongs-to.md) - [Get the Current Organization for the current user](https://docs.virtuous.org/api-reference/organization/gets-the-current-organization-user.md) - [Get Permissions for the current user](https://docs.virtuous.org/api-reference/organization/gets-this-permissions-for-the-current-user.md) - [Switch the Current Organization](https://docs.virtuous.org/api-reference/organization/switch-the-current-organization.md) - [Create a New Organization](https://docs.virtuous.org/api-reference/organizations/create-a-new-organization.md): Creates a new Organization and attaches it to the requesting partner's family. This endpoint is restricted to an authorize… - [Get Details for Organizations in your Organizations Family](https://docs.virtuous.org/api-reference/organizations/get-details-for-organizations-in-your-organizations-family.md): Returns all organizations in your organization family — your own organization together with its parent and child organizat… - [Get Organization Details](https://docs.virtuous.org/api-reference/organizations/get-organization-details.md): Returns the full detail record for a single organization, including its child and parent organization relationships. The r… - [Create a Knowledge Source](https://docs.virtuous.org/api-reference/orgknowledge/create-a-knowledge-source.md) - [Delete a Knowledge Source](https://docs.virtuous.org/api-reference/orgknowledge/delete-a-knowledge-source.md) - [Get a Knowledge Source](https://docs.virtuous.org/api-reference/orgknowledge/get-a-knowledge-source.md) - [List Knowledge Sources](https://docs.virtuous.org/api-reference/orgknowledge/list-knowledge-sources.md) - [Reindex a Knowledge Source](https://docs.virtuous.org/api-reference/orgknowledge/reindex-a-knowledge-source.md) - [Update a Knowledge Source](https://docs.virtuous.org/api-reference/orgknowledge/update-a-knowledge-source.md) - [Upload a Knowledge Source File](https://docs.virtuous.org/api-reference/orgknowledge/upload-a-knowledge-source-file.md) - [Contact Transaction](https://docs.virtuous.org/api-reference/pentest/contact-transaction.md) - [CustomField Search](https://docs.virtuous.org/api-reference/pentest/custom-field-search.md) - [Campaign by ID](https://docs.virtuous.org/api-reference/pentest/get-campaign-by-id.md) - [Gift By Reference](https://docs.virtuous.org/api-reference/pentest/gift-by-reference.md): HMAC Auth only. - [Organization Switch](https://docs.virtuous.org/api-reference/pentest/organization-switch.md) - [Campaign Query](https://docs.virtuous.org/api-reference/pentest/query-campaigns.md): To see which options can be sent, use the {M:Virtuous.WebApi.Controllers.CampaignController.QueryOptions} endpoint. If re… - [Create a Planned Gift](https://docs.virtuous.org/api-reference/planned-gift/created-a-new-planned-gift.md) - [Get Planned Gift Custom Fields Available](https://docs.virtuous.org/api-reference/planned-gift/get-the-custom-fields-available-for-planned-gifts.md): Will return all enabled custom fields available for the Planned Gift object. - [Get Gifts Applied to a Planned Gift](https://docs.virtuous.org/api-reference/planned-gift/gets-the-gifts-applied-to-the-specified-planned-gift.md) - [Get Planned Gifts for a Contact](https://docs.virtuous.org/api-reference/planned-gift/gets-the-planned-gifts-for-the-specified-contact.md) - [Get Planned Gift](https://docs.virtuous.org/api-reference/planned-gift/gets-the-specified-planned-gift.md) - [Query Planned Gifts](https://docs.virtuous.org/api-reference/planned-gift/request-planned-gifts-with-a-custom-query.md) - [Get Planned Gift Query Options](https://docs.virtuous.org/api-reference/planned-gift/request-query-options-to-build-a-query-for-planned-gifts.md) - [Update a Planned Gift](https://docs.virtuous.org/api-reference/planned-gift/updates-a-planned-gift.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Create a Pledge](https://docs.virtuous.org/api-reference/pledge/create-a-new-pledge-for-a-contact.md) - [Get Pledge Custom Fields Available](https://docs.virtuous.org/api-reference/pledge/get-the-custom-fields-available-for-pledges.md): Will return all enabled custom fields available for the Pledge object. - [Get Pledges for a Contact](https://docs.virtuous.org/api-reference/pledge/gets-the-pledges-for-the-specified-contact.md) - [Get Pledge](https://docs.virtuous.org/api-reference/pledge/gets-the-specified-pledge.md) - [Query Pledges](https://docs.virtuous.org/api-reference/pledge/request-pledges-with-a-custom-query.md) - [Get Pledge Query Options](https://docs.virtuous.org/api-reference/pledge/request-query-options-to-build-a-query-for-pledges.md) - [Update a Pledge](https://docs.virtuous.org/api-reference/pledge/update-an-existing-pledge.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Write-off the Pledge](https://docs.virtuous.org/api-reference/pledge/write-off-the-specified-pledge.md) - [Pledges](https://docs.virtuous.org/api-reference/pledges.md) - [Create a Premium](https://docs.virtuous.org/api-reference/premium/create-a-new-premium.md) - [Create a Premium](https://docs.virtuous.org/api-reference/premium/create-a-premium.md) - [Deactivate a Premium](https://docs.virtuous.org/api-reference/premium/deactivate-a-premium.md) - [Decrement the inventory count](https://docs.virtuous.org/api-reference/premium/decrement-the-inventory-count.md): The decrementor defaults to -1 and MUST be a negative number. If you need to increment, use the Increment Premium endpoint. - [Delete a Premium](https://docs.virtuous.org/api-reference/premium/delete-a-premium.md) - [Find Premiums](https://docs.virtuous.org/api-reference/premium/find-premiums-using-the-specified-parameters.md) - [Get a Premium](https://docs.virtuous.org/api-reference/premium/get-a-premium.md) - [Get Premium using a unique Code](https://docs.virtuous.org/api-reference/premium/get-premium-by-code.md) - [Get Premium](https://docs.virtuous.org/api-reference/premium/get-premium-by-id.md) - [Get Premium Deactivation Impact](https://docs.virtuous.org/api-reference/premium/get-premium-deactivation-impact.md) - [Get Premium Query Options](https://docs.virtuous.org/api-reference/premium/get-premium-query-options.md) - [Get Premium Custom Fields Available](https://docs.virtuous.org/api-reference/premium/get-the-custom-fields-available-for-premiums.md): Will return all enabled custom fields available for the Premium object. - [Increment the inventory count](https://docs.virtuous.org/api-reference/premium/increment-the-inventory-count.md): The incrementor defaults to 1 and MUST be a positive number. If you need to decrement, use the Decrement Premium endpoint. - [List All Premiums](https://docs.virtuous.org/api-reference/premium/list-all-premiums.md) - [Query Premiums](https://docs.virtuous.org/api-reference/premium/query-premiums.md) - [Update a Premium](https://docs.virtuous.org/api-reference/premium/update-a-premium.md) - [Update a Premium](https://docs.virtuous.org/api-reference/premium/update-an-existing-premium.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Create many Project Expenses](https://docs.virtuous.org/api-reference/project-expense/create-multiple-project-expenses.md) - [Create a Project Expense](https://docs.virtuous.org/api-reference/project-expense/create-project-expense.md) - [Get Project Expenses for a Project](https://docs.virtuous.org/api-reference/project-expense/get-all-project-expenses-that-match-the-specified-parameters.md) - [Get Project Expense](https://docs.virtuous.org/api-reference/project-expense/get-by-id.md) - [Update a Project Expense](https://docs.virtuous.org/api-reference/project-expense/update-project-expense.md) - [Create a Project Note](https://docs.virtuous.org/api-reference/project-note/creates-a-new-note-for-the-specified-project.md) - [Delete a Project Note](https://docs.virtuous.org/api-reference/project-note/deletes-the-specified-project-note.md) - [Get Notes for a Project](https://docs.virtuous.org/api-reference/project-note/gets-the-notes-for-the-specified-project.md) - [Get Project Note](https://docs.virtuous.org/api-reference/project-note/gets-the-specified-note.md) - [Get Project Note Types](https://docs.virtuous.org/api-reference/project-note/gets-the-types-of-contact-methods.md) - [Update a Project Note](https://docs.virtuous.org/api-reference/project-note/updates-a-project-note.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Create a Project Role](https://docs.virtuous.org/api-reference/project-role/creates-a-new-project-role.md) - [Delete a Project Role](https://docs.virtuous.org/api-reference/project-role/deletes-the-project-role.md) - [Get Project Roles for a Contact](https://docs.virtuous.org/api-reference/project-role/gets-project-roles-by-contact.md) - [Get Project Roles for a Project](https://docs.virtuous.org/api-reference/project-role/gets-project-roles-by-project.md) - [Get Project Role](https://docs.virtuous.org/api-reference/project-role/gets-the-project-role.md) - [Get Project Role Types](https://docs.virtuous.org/api-reference/project-role/gets-the-project-role-types.md) - [Update a Project Role](https://docs.virtuous.org/api-reference/project-role/updates-project-role.md) - [Update many Projects](https://docs.virtuous.org/api-reference/project/bulk-update.md): Use this endpoint anytime more than 1 project is going to be updated. Please note that unlike other update endpoints thi… - [Check if Project Code Exists](https://docs.virtuous.org/api-reference/project/check-if-project-code-exists.md) - [Create a Project](https://docs.virtuous.org/api-reference/project/create-a-project.md) - [Create a Project](https://docs.virtuous.org/api-reference/project/create-project.md) - [Delete a Project](https://docs.virtuous.org/api-reference/project/delete-a-project.md) - [Find Projects](https://docs.virtuous.org/api-reference/project/find-projects.md) - [Get a Project](https://docs.virtuous.org/api-reference/project/get-a-project.md) - [Get a Project by Code](https://docs.virtuous.org/api-reference/project/get-a-project-by-code.md) - [Get a Project using a unique Code](https://docs.virtuous.org/api-reference/project/get-project-by-code.md) - [Get Project](https://docs.virtuous.org/api-reference/project/get-project-by-id.md) - [Get Project Dependency Count](https://docs.virtuous.org/api-reference/project/get-project-dependency-count.md) - [Get Project Types](https://docs.virtuous.org/api-reference/project/get-project-types.md) - [Get Project Custom Fields Available](https://docs.virtuous.org/api-reference/project/get-the-custom-fields-available-for-projects.md): Will return all enabled custom fields available for the Project object. - [List All Projects](https://docs.virtuous.org/api-reference/project/list-all-projects.md) - [List Project Donors](https://docs.virtuous.org/api-reference/project/list-project-donors.md) - [List Project Gifts](https://docs.virtuous.org/api-reference/project/list-project-gifts.md) - [Get Project Query Options](https://docs.virtuous.org/api-reference/project/project-query-options.md): Returns all possible query options for Projects. - [Query Projects](https://docs.virtuous.org/api-reference/project/query-projects.md): To see which options can be sent, use the {M:Virtuous.WebApi.Controllers.ProjectController.QueryOptions} endpoint. If you… - [Replace a Project](https://docs.virtuous.org/api-reference/project/replace-a-project.md) - [Temporarily Change Project Inventory Status](https://docs.virtuous.org/api-reference/project/temporarily-change-project-inventory-status.md) - [Update a Project](https://docs.virtuous.org/api-reference/project/update-a-project.md) - [Update a Project](https://docs.virtuous.org/api-reference/project/update-project.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Update Project Balance](https://docs.virtuous.org/api-reference/project/update-project-balance.md) - [Create a Project](https://docs.virtuous.org/api-reference/projects/create-a-project.md): Creates a new volunteer project (opportunity) for your organization. Required fields are name, description, age_limit, pri… - [Get Project Date Details](https://docs.virtuous.org/api-reference/projects/get-project-date-details.md): Returns the detail record for a single project serving date (also called a 'happening'), including the list of participant… - [Get Project Details](https://docs.virtuous.org/api-reference/projects/get-project-details.md): Returns the full detail record for a single volunteer project, including all serving dates, associated campaigns, and imag… - [List / Find Projects](https://docs.virtuous.org/api-reference/projects/list-find-projects.md): Returns a paginated list of volunteer projects belonging to your organization family. No status filter is applied unless r… - [List of Projects and Volunteers Today](https://docs.virtuous.org/api-reference/projects/list-of-projects-and-volunteers-today.md): Returns all volunteer projects happening today (based on your organization's timezone), along with the list of signed-up v… - [Update a Project](https://docs.virtuous.org/api-reference/projects/update-a-project.md): Updates an existing volunteer project. All required project fields must be supplied. Serving dates are upserted: a date wi… - [Create a Saved Query](https://docs.virtuous.org/api-reference/query/create-a-saved-query.md) - [Delete a Saved Query](https://docs.virtuous.org/api-reference/query/delete-a-saved-query.md) - [Get Query Options](https://docs.virtuous.org/api-reference/query/get-query-options.md) - [List Saved Queries](https://docs.virtuous.org/api-reference/query/list-saved-queries.md) - [Look Up Query Parameter Options](https://docs.virtuous.org/api-reference/query/look-up-query-parameter-options.md) - [Parse a Query String](https://docs.virtuous.org/api-reference/query/parse-a-query-string.md) - [Update a Saved Query](https://docs.virtuous.org/api-reference/query/update-a-saved-query.md) - [Calculate Payment Processing Cost](https://docs.virtuous.org/api-reference/raise/calculate-payment-processing-cost.md) - [Generate Test Payment Method](https://docs.virtuous.org/api-reference/raise/generate-test-payment-method.md) - [Post apiraiselead](https://docs.virtuous.org/api-reference/raise/post-apiraiselead.md) - [Process a Donation Payment](https://docs.virtuous.org/api-reference/raise/process-a-donation-payment.md) - [Recurring Gift Payments](https://docs.virtuous.org/api-reference/recurring-gift-payments.md) - [Cancel a Recurring Gift](https://docs.virtuous.org/api-reference/recurring-gift/cancels-the-specified-recurring-gift.md) - [Create a Recurring Gift](https://docs.virtuous.org/api-reference/recurring-gift/created-a-new-recurring-gift.md) - [Get Recurring Gift Custom Fields Available](https://docs.virtuous.org/api-reference/recurring-gift/get-the-custom-fields-available-for-recurring-gifts.md): Will return all enabled custom fields available for the Recurring Gift object. - [Get Payments for a Recurring Gift](https://docs.virtuous.org/api-reference/recurring-gift/gets-recurring-gift-payments-for-the-specified-recurring-gift-identifier.md) - [Get Recurring Gifts for a Contact](https://docs.virtuous.org/api-reference/recurring-gift/gets-the-recurring-gifts-for-the-specified-contact.md) - [Get a Recurring Gift](https://docs.virtuous.org/api-reference/recurring-gift/gets-the-specified-recurring-gift.md) - [Get Recurring Gift Query Options](https://docs.virtuous.org/api-reference/recurring-gift/request-query-options-to-build-a-query-for-recurring-gifts.md) - [Query Recurring Gifts](https://docs.virtuous.org/api-reference/recurring-gift/request-recurring-gifts-with-a-custom-query.md) - [Update a Recurring Gift](https://docs.virtuous.org/api-reference/recurring-gift/update-an-existing-recurring-gift.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Recurring Gifts](https://docs.virtuous.org/api-reference/recurring-gifts.md) - [Cancel a Recurring Gift](https://docs.virtuous.org/api-reference/recurringgift/cancel-a-recurring-gift.md) - [Get a Recurring Gift](https://docs.virtuous.org/api-reference/recurringgift/get-a-recurring-gift.md) - [List All Recurring Gifts](https://docs.virtuous.org/api-reference/recurringgift/list-all-recurring-gifts.md) - [List Recurring Gift Activities](https://docs.virtuous.org/api-reference/recurringgift/list-recurring-gift-activities.md) - [Query Recurring Gifts](https://docs.virtuous.org/api-reference/recurringgift/query-recurring-gifts.md) - [Update a Recurring Gift](https://docs.virtuous.org/api-reference/recurringgift/update-a-recurring-gift.md) - [Create a Relationship](https://docs.virtuous.org/api-reference/relationship/creates-a-new-relationship.md) - [Delete a Relationship](https://docs.virtuous.org/api-reference/relationship/deletes-the-specified-relationship.md) - [Get Relationships for a Contact](https://docs.virtuous.org/api-reference/relationship/gets-the-relationships-for-the-specified-contact.md) - [Get Relationship Types](https://docs.virtuous.org/api-reference/relationship/gets-the-types-of-relationships.md) - [Update a Relationship](https://docs.virtuous.org/api-reference/relationship/update-an-existing-relationship.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Complete Reminder](https://docs.virtuous.org/api-reference/reminder/complete-reminder.md) - [Create Manual Reminder](https://docs.virtuous.org/api-reference/reminder/create-manual-reminder.md) - [Create Milestone Reminder](https://docs.virtuous.org/api-reference/reminder/create-milestone-reminder.md) - [Create Recurring Reminder](https://docs.virtuous.org/api-reference/reminder/create-recurring-reminder.md) - [Dismiss Reminder](https://docs.virtuous.org/api-reference/reminder/dismiss-reminder.md) - [Get Active Manual Reminders by Contact](https://docs.virtuous.org/api-reference/reminder/get-active-manual-reminders-by-contact.md) - [Get Active Reminders (for current user)](https://docs.virtuous.org/api-reference/reminder/get-active-reminders-for-current-user.md) - [Get Inactive Manual Reminders by Contact](https://docs.virtuous.org/api-reference/reminder/get-inactive-manual-reminders-by-contact.md) - [Get Reminder Source Types](https://docs.virtuous.org/api-reference/reminder/get-reminder-source-types.md) - [Get Reminder Types](https://docs.virtuous.org/api-reference/reminder/get-reminder-types.md) - [Get Saved Reminders (for current user)](https://docs.virtuous.org/api-reference/reminder/get-saved-reminders-for-current-user.md) - [Get Unresolved Manual Reminders by Contact](https://docs.virtuous.org/api-reference/reminder/get-unresolved-manual-reminders-by-contact.md) - [Gets Milestone Types](https://docs.virtuous.org/api-reference/reminder/gets-milestone-types.md) - [Gets Reminder Frequency Types](https://docs.virtuous.org/api-reference/reminder/gets-reminder-frequency-types.md) - [Update Milestone Reminder.](https://docs.virtuous.org/api-reference/reminder/update-milestone-reminder.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Update Recurring Reminder](https://docs.virtuous.org/api-reference/reminder/update-recurring-reminder.md): Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only… - [Search](https://docs.virtuous.org/api-reference/search.md) - [Search for Contacts, Individuals or Entities](https://docs.virtuous.org/api-reference/search/search-for-contacts-individuals-or-entities.md) - [Check if Segment Exists](https://docs.virtuous.org/api-reference/segment/check-if-segment-exists.md) - [Create a Segment](https://docs.virtuous.org/api-reference/segment/create-a-new-segment.md) - [Create a Segment](https://docs.virtuous.org/api-reference/segment/create-a-segment.md) - [Delete a Segment](https://docs.virtuous.org/api-reference/segment/delete-a-segment.md) - [Find Segments](https://docs.virtuous.org/api-reference/segment/find-segments-using-the-specified-parameters.md) - [Get a Segment](https://docs.virtuous.org/api-reference/segment/get-a-segment.md) - [Get Segment Page Count](https://docs.virtuous.org/api-reference/segment/get-segment-page-count.md) - [Get the Segments for a Contact](https://docs.virtuous.org/api-reference/segment/get-segments-by-contact.md) - [Get a Segment using a unique Code](https://docs.virtuous.org/api-reference/segment/get-the-segment-by-code.md) - [Get a Segment](https://docs.virtuous.org/api-reference/segment/get-the-segment-by-id.md) - [List All Segments](https://docs.virtuous.org/api-reference/segment/list-all-segments.md) - [List Segment Donors](https://docs.virtuous.org/api-reference/segment/list-segment-donors.md) - [List Segment Gifts](https://docs.virtuous.org/api-reference/segment/list-segment-gifts.md) - [Query Segments](https://docs.virtuous.org/api-reference/segment/query-segments.md) - [Replace a Segment](https://docs.virtuous.org/api-reference/segment/replace-a-segment.md) - [Update a Segment](https://docs.virtuous.org/api-reference/segment/update-a-segment.md) - [Update a Segment](https://docs.virtuous.org/api-reference/segment/update-an-existing-segment.md) - [Segments](https://docs.virtuous.org/api-reference/segments.md) - [Find all Tags that match, fully or partially](https://docs.virtuous.org/api-reference/tag/find-all-tags-that-match-fully-or-partially-the-given-search-parameter.md) - [Get all Tags](https://docs.virtuous.org/api-reference/tag/gets-the-tags-for-the-current-organization.md) - [Create a Task](https://docs.virtuous.org/api-reference/task/create-a-task.md) - [Get Task Query Options](https://docs.virtuous.org/api-reference/task/get-task-query-options.md) - [Get Task Types](https://docs.virtuous.org/api-reference/task/get-task-types.md) - [Query Tasks](https://docs.virtuous.org/api-reference/task/query-tasks.md): To see which options can be sent, use the Get Task Query Options endpoint. If requests are timing out, you may be asking… - [Tasks](https://docs.virtuous.org/api-reference/tasks.md) - [Create a Tribute](https://docs.virtuous.org/api-reference/tribute/creates-a-new-tribute-using-the-specified-post-model.md) - [Search for Tributes](https://docs.virtuous.org/api-reference/tribute/searches-for-tributes-that-match-the-given-criteria.md) - [Update a Tribute](https://docs.virtuous.org/api-reference/tribute/updates-the-tribute-with-the-specified-identifier-using-the-details-of-the-specified-put-model.md) - [Create / Update User](https://docs.virtuous.org/api-reference/users/create-update-user.md): Upserts a user by email address. If no user with the given email exists, a new user is created and a 201 response is retur… - [Get User Details](https://docs.virtuous.org/api-reference/users/get-user-details.md): Returns the full profile record for a single user who is a member of your organization, including their membership details… - [List / Find Users](https://docs.virtuous.org/api-reference/users/list-find-users.md): Returns a paginated list of users who are members of your organization. Use this endpoint to sync volunteer records into a… - [Create a Volunteer](https://docs.virtuous.org/api-reference/volunteer-opportunity/create-a-new-volunteer-assigned-to-the-specified-volunteer-opportunity-using-the-details-in-the-specified-post-model.md) - [Create a Volunteer Opportunity](https://docs.virtuous.org/api-reference/volunteer-opportunity/creates-a-new-volunteer-opportunity-using-the-details-specified-in-the-post-model.md) - [Create a Volunteer Organizer](https://docs.virtuous.org/api-reference/volunteer-opportunity/creates-a-new-volunteer-organizer-assigned-to-the-specified-volunteer-opportunity-using-the-details-of-the-specified-post-model.md) - [Create a Volunteer Attendance](https://docs.virtuous.org/api-reference/volunteer-opportunity/creates-a-volunteer-attendance-using-the-specified-volunteer-opportunity-and-volunteer-identifiers-and-the-details-of-the-specified-post-model.md) - [Delete a Volunteer Opportunity](https://docs.virtuous.org/api-reference/volunteer-opportunity/deletes-the-specified-volunteer-opportunity-with-the-specified-identifier.md) - [Delete a Volunteer Attendance](https://docs.virtuous.org/api-reference/volunteer-opportunity/deletes-the-volunteer-attendance-with-the-specified-identifier.md) - [Delete a Volunteer Organizer](https://docs.virtuous.org/api-reference/volunteer-opportunity/deletes-the-volunteer-organizer-with-the-specified-identifier.md) - [Delete a Volunteer](https://docs.virtuous.org/api-reference/volunteer-opportunity/deletes-the-volunteer-with-the-specified-identifier.md) - [Get Query Options](https://docs.virtuous.org/api-reference/volunteer-opportunity/get-volunteer-opportunity-query-options.md): Available starting 3/29/2022 - [Get Volunteer Organizers](https://docs.virtuous.org/api-reference/volunteer-opportunity/gets-all-volunteer-organizers-for-the-specified-volunteer-opportunity.md) - [Get Volunteers for a Volunteer Opportunity](https://docs.virtuous.org/api-reference/volunteer-opportunity/gets-all-volunteers-for-the-specified-volunteer-opportunity.md) - [Get Custom Fields Available](https://docs.virtuous.org/api-reference/volunteer-opportunity/gets-the-custom-fields-for-volunteer-opportunities.md): Will return all enabled custom fields available for the volunteer opportunities object. - [Get Volunteer Opportunity](https://docs.virtuous.org/api-reference/volunteer-opportunity/gets-the-specified-volunteer-opportunity-with-the-specified-identifier.md) - [Get Volunteer Organizer](https://docs.virtuous.org/api-reference/volunteer-opportunity/gets-the-specified-volunteer-organizer-with-the-specified-identifier.md) - [Get Volunteer Attendance for a Volunteer](https://docs.virtuous.org/api-reference/volunteer-opportunity/gets-the-volunteer-attendance-for-the-specified-volunteer.md) - [Get Volunteer Attendance](https://docs.virtuous.org/api-reference/volunteer-opportunity/gets-the-volunteer-attendance-with-the-specified-identifier.md) - [Get Volunteer Opportunities](https://docs.virtuous.org/api-reference/volunteer-opportunity/gets-the-volunteer-opportunities.md) - [Get Volunteer](https://docs.virtuous.org/api-reference/volunteer-opportunity/gets-the-volunteer-with-the-specified-identifier.md) - [Queries Volunteer Opportunities](https://docs.virtuous.org/api-reference/volunteer-opportunity/query-volunteer-opportunities.md): Available starting 3/29/2022 - [Update a Volunteer Opportunity](https://docs.virtuous.org/api-reference/volunteer-opportunity/updates-a-volunteer-opportunity-with-the-specified-identifier.md) - [Update a Volunteer Attendance](https://docs.virtuous.org/api-reference/volunteer-opportunity/updates-the-volunteer-attendance-with-the-specified-identifier-using-the-details-in-the-specified-put-model.md) - [Get Query Options](https://docs.virtuous.org/api-reference/volunteer/get-volunteer-query-options.md): Available starting 3/29/2022 - [Query Volunteers](https://docs.virtuous.org/api-reference/volunteer/query-volunteers.md): Available starting 3/29/2022 - [Search for Volunteers](https://docs.virtuous.org/api-reference/volunteer/search-for-volunteers.md): Available starting 3/29/2022 - [Add RaiseDonors Tenant Id to Webhook Headers](https://docs.virtuous.org/api-reference/webhook/add-raisedonors-tenant-id-to-webhook-headers.md): HMAC or OAuth Auth valid. This is the recommended way to update projects. - [Create a Webhook](https://docs.virtuous.org/api-reference/webhook/create-a-webhook.md) - [Delete a Webhook](https://docs.virtuous.org/api-reference/webhook/delete-a-webhook.md) - [Get a Webhook](https://docs.virtuous.org/api-reference/webhook/get-a-webhook.md) - [Get a Webhook](https://docs.virtuous.org/api-reference/webhook/get-a-webhook-by-the-identifier.md) - [Get a Webhook Log](https://docs.virtuous.org/api-reference/webhook/get-a-webhook-log.md) - [List All Webhook Logs](https://docs.virtuous.org/api-reference/webhook/list-all-webhook-logs.md) - [List All Webhooks](https://docs.virtuous.org/api-reference/webhook/list-all-webhooks.md) - [List Webhook Logs](https://docs.virtuous.org/api-reference/webhook/list-webhook-logs.md) - [Set the active state of a Webhook](https://docs.virtuous.org/api-reference/webhook/set-the-active-state-of-a-webhook.md) - [Update a Webhook](https://docs.virtuous.org/api-reference/webhook/update-a-webhook.md) - [Working with Collections](https://docs.virtuous.org/api-reference/working-with-collections.md) - [Get Zapier Event Samples](https://docs.virtuous.org/api-reference/zapier/get-zapier-event-samples.md) - [Subscribe to Zapier Webhook](https://docs.virtuous.org/api-reference/zapier/subscribe-to-zapier-webhook.md) - [Test Zapier Connection](https://docs.virtuous.org/api-reference/zapier/test-zapier-connection.md) - [Unsubscribe from Zapier Webhook](https://docs.virtuous.org/api-reference/zapier/unsubscribe-from-zapier-webhook.md) - [Analytics Changelog](https://docs.virtuous.org/changelog/analytics.md) - [CRM+ Changelog](https://docs.virtuous.org/changelog/crm.md): Use this changelog to stay informed about changes that may impact CRM+ integrations, data syncs, partner apps, and custom… - [Momentum Changelog](https://docs.virtuous.org/changelog/momentum.md): Use this changelog to stay informed about changes that may impact Momentum integrations, automated workflows, and custom e… - [Product Hub](https://docs.virtuous.org/changelog/product-hub-analytics.md) - [Product Hub](https://docs.virtuous.org/changelog/product-hub-crm.md) - [Product Hub](https://docs.virtuous.org/changelog/product-hub-momentum.md) - [Product Hub](https://docs.virtuous.org/changelog/product-hub-raise.md) - [Product Hub](https://docs.virtuous.org/changelog/product-hub-volunteer.md) - [Raise Changelog](https://docs.virtuous.org/changelog/raise.md) - [Volunteer Changelog](https://docs.virtuous.org/changelog/volunteer.md): Use this changelog to stay informed about changes that may impact volunteer management integrations, partner apps, and cus… - [Authentication](https://docs.virtuous.org/crm/authentication.md): API Keys, OAuth tokens, and how to attach credentials to every CRM+ API request. - [Base URLs and Environments](https://docs.virtuous.org/crm/base-urls.md): The CRM+ base URL, environment scoping, and how partner integrations should handle credentials across multiple nonprofit c… - [API Performance Tips](https://docs.virtuous.org/crm/best-practices/api-performance-tips.md): Practical guidance for making your Virtuous CRM+ integration fast and efficient — pagination strategy, response shape sele… - [Data Modeling Best Practices](https://docs.virtuous.org/crm/best-practices/data-modeling-best-practices.md): How to model your platform's data inside Virtuous so it stays clean, reportable, and reconcilable over time — Contact type… - [Error Recovery Patterns](https://docs.virtuous.org/crm/best-practices/error-recovery-patterns.md): The patterns for building an integration that recovers gracefully from the inevitable failures — categorizing errors, retr… - [Security & Credential Management](https://docs.virtuous.org/crm/best-practices/security-and-credential-management.md): How to store, rotate, and protect the credentials and secrets your CRM+ integration depends on — Virtuous API tokens, webh… - [Sync Architecture Patterns](https://docs.virtuous.org/crm/best-practices/sync-architecture-patterns.md): The recurring architectural patterns for partner integrations syncing data with CRM+ — when to use each, how they compose,… - [Versioning & Backward Compatibility](https://docs.virtuous.org/crm/best-practices/versioning-and-backward-compatibility.md): How CRM+'s versioning model affects partner integrations — the /v2/ endpoints in the API today, what versioning commitment… - [Contacts](https://docs.virtuous.org/crm/concepts/contacts.md): The Contact, ContactIndividual, ContactAddress, and ContactMethod resources — how the donor data model is structured and w… - [Custom Fields](https://docs.virtuous.org/crm/concepts/custom-fields.md): How nonprofits extend the CRM+ data model with organization-specific fields, and how partner integrations should discover,… - [Data Model](https://docs.virtuous.org/crm/concepts/data-model.md): The core resources in Virtuous CRM+ and how they relate — the mental model every integration partner needs before writing… - [Funds, Campaigns & Designations](https://docs.virtuous.org/crm/concepts/funds-campaigns-designation.md): How money flows from a Gift through GiftDesignations to fund Projects under Campaigns — and how Virtuous's terminology map… - [Donations / Gifts](https://docs.virtuous.org/crm/concepts/gifts.md): The Gift resource — what a Gift represents, how it relates to Contacts and Projects, the gift types CRM+ supports, and the… - [Relationships & IDs](https://docs.virtuous.org/crm/concepts/relationships-and-ids.md): How CRM+ identifies records — primary keys, foreign keys, external references — and how the Relationship resource models c… - [Statuses & Lifecycle States](https://docs.virtuous.org/crm/concepts/statuses-and-lifecycle.md): The boolean flags and status fields that control how records behave across CRM+ — Contacts, Projects, Campaigns, Recurring… - [Transactions](https://docs.virtuous.org/crm/concepts/transactions.md): The Transaction endpoints — Virtuous's recommended pattern for importing Contacts and Gifts from external systems with bui… - [Error Handling](https://docs.virtuous.org/crm/error-handling.md): The CRM+ error response shape, all standard error codes, and how to write defensive client code that survives the API's cu… - [Make Your First API Call](https://docs.virtuous.org/crm/first-api-call.md): A detailed walkthrough of one CRM+ API request — the URL, headers, response, and how to debug common first-call failures. - [Overview](https://docs.virtuous.org/crm/overview.md): Build integrations with Virtuous CRM+ — the constituent and giving platform used by thousands of nonprofits. - [Quickstart](https://docs.virtuous.org/crm/quickstart.md): Get an API key and make a useful request against Virtuous CRM+ in under 5 minutes. - [Rate Limits](https://docs.virtuous.org/crm/rate-limits.md): CRM+ API rate limit thresholds, response headers, and how to handle 429 responses gracefully in production integrations. - [Auction/Event Platform to Virtuous CRM](https://docs.virtuous.org/crm/recipes/auction-event-platform-to-virtuous.md): A complete integration recipe for syncing auction and event-management platforms with Virtuous CRM+ — splitting ticket and… - [Build a Nightly Data Sync](https://docs.virtuous.org/crm/recipes/build-a-nightly-data-sync.md): A complete recipe for batched, scheduled sync between an external platform and Virtuous CRM+ — when nightly is the right c… - [Constant Contact to Virtuous CRM](https://docs.virtuous.org/crm/recipes/constant-contact-to-virtuous.md): A complete integration recipe for syncing email subscribers between Constant Contact and Virtuous CRM+ — List-to-Tag mappi… - [Fundraising Platform to Virtuous CRM](https://docs.virtuous.org/crm/recipes/fundraising-platform-to-virtuous.md): A complete integration recipe for syncing peer-to-peer, crowdfunding, and team-based fundraising platforms with Virtuous C… - [Import Historical Gifts](https://docs.virtuous.org/crm/recipes/import-historical-gifts.md): A complete recipe for backfilling a customer's historical donation data into Virtuous — pre-flight planning, validation, t… - [Mailchimp to Virtuous CRM](https://docs.virtuous.org/crm/recipes/mailchimp-to-virtuous.md): A complete integration recipe for syncing email subscribers between Mailchimp and Virtuous CRM+ — Audience-to-Tag mapping,… - [Stripe to Virtuous CRM](https://docs.virtuous.org/crm/recipes/stripe-to-virtuous.md): A complete integration recipe for syncing donations from Stripe into Virtuous CRM+ — Customer-to-Contact mapping, Charge-t… - [Sync Recurring Donor Updates](https://docs.virtuous.org/crm/recipes/sync-recurring-donor-updates.md): Coordinate a donor's recurring giving schedule between your platform and Virtuous — creation, amount changes, pauses, canc… - [Event Types](https://docs.virtuous.org/crm/webhooks/event-types.md): The webhook event types CRM+ delivers — what each event represents, when it fires, and what its payload contains. - [Idempotency & Safe Reprocessing](https://docs.virtuous.org/crm/webhooks/idempotency-and-safe-processing.md): Why your webhook handler will receive duplicate deliveries, why ordinary database writes are not enough, and the patterns… - [Local Testing](https://docs.virtuous.org/crm/webhooks/local-testing.md): How to receive Virtuous webhook deliveries on a development machine using tunneling tools, capture fixtures for replay tes… - [Retry Behavior](https://docs.virtuous.org/crm/webhooks/retry-behavior.md): What happens when your webhook endpoint fails to acknowledge a delivery — when Virtuous retries, when it gives up, and how… - [Signature Verification](https://docs.virtuous.org/crm/webhooks/signature-verification.md): How to verify that an incoming webhook request was sent by Virtuous and was not modified in transit — the security foundat… - [Webhooks Overview](https://docs.virtuous.org/crm/webhooks/webhooks-overview.md): How webhooks work in CRM+ — what they are, how to subscribe, and why every partner integration should use them instead of… - [Build a Two-Way Sync](https://docs.virtuous.org/crm/workflows/build-a-two-way-sync.md): Extend one-way donation sync into a continuous bidirectional sync — propagating changes from your platform to Virtuous and… - [Create a Contact](https://docs.virtuous.org/crm/workflows/create-a-contact.md): End-to-end walkthrough for creating a Contact in CRM+ — when to use the Transaction endpoint versus direct creation, and h… - [Create a Donation](https://docs.virtuous.org/crm/workflows/create-a-donation.md): Record a Gift in CRM+ end-to-end — choosing between the Transaction endpoint and direct creation, structuring designations… - [Handle Duplicate Records](https://docs.virtuous.org/crm/workflows/handle-duplicate-records.md): How duplicates appear in CRM+ despite the Transaction matching algorithm, how to detect them, and what your partner integr… - [Query Contacts by Filters](https://docs.virtuous.org/crm/workflows/query-contacts-by-filters.md): Retrieve Contact records by structured filter criteria — incremental sync by modification date, tag-based segmentation que… - [Query Donations by Date Range](https://docs.virtuous.org/crm/workflows/query-donations-by-date-range.md): Retrieve Gift records by date range — reporting exports, reconciliation snapshots, and incremental sync of gift data into… - [Reconcile Failed Syncs](https://docs.virtuous.org/crm/workflows/reconcile-failed-syncs.md): Detect, investigate, and resolve the sync failures that any production integration eventually encounters — stuck Transacti… - [Sync External Donations into Virtuous](https://docs.virtuous.org/crm/workflows/sync-external-donations-into-virtuous.md): The canonical end-to-end architecture for pushing donations from your platform into CRM+ — idempotent, reconcilable, and r… - [Update a Contact](https://docs.virtuous.org/crm/workflows/update-a-contact.md): How to safely modify an existing Contact in CRM+ without overwriting fields you did not intend to change. - [Terms & Definitions](https://docs.virtuous.org/general/glossary.md) - [Welcome](https://docs.virtuous.org/index.md): Everything you need to connect your systems with Virtuous CRM, Volunteer, and Raise platforms through our powerful APIs. - [Annual Fund](https://docs.virtuous.org/momentum/guides/annual-fund.md): A practical guide for Annual Fund Officers to engage broad donor bases, boost retention, and build a strong pipeline using… - [Corporate Gifts](https://docs.virtuous.org/momentum/guides/corporate-gifts.md): A relationship-focused guide for Corporate Giving Officers to manage partnerships, fulfill sponsorship deliverables, and s… - [Major Gifts](https://docs.virtuous.org/momentum/guides/major-gifts.md): A personalized guide for Major Gift Officers to manage donor relationships, plan strategic outreach, and move supporters t… - [Midlevel Giving](https://docs.virtuous.org/momentum/guides/midlevel-leadership-giving.md): A practical guide for Mid-Level and Leadership Giving Officers to engage, upgrade, and identify rising donors while buildi… - [Planned Giving](https://docs.virtuous.org/momentum/guides/planned-giving.md): A relationship-centered guide for Planned Giving Officers to qualify prospects, educate donors, and steward legacy commitm… - [Onboarding Guide](https://docs.virtuous.org/momentum/onboarding-guide.md): Get up and running with Momentum! - [Overview](https://docs.virtuous.org/momentum/overview.md): A fundraising platform designed to protect your peace while helping you stay personal at scale—smart automation, generativ… - [Authentication](https://docs.virtuous.org/raise/authentication.md): How to authenticate against the Raise API — the JWT Bearer scheme, header format, and credential lifecycle considerations. - [Base URLs & Environments](https://docs.virtuous.org/raise/base-urls.md): The Raise API host, how environment selection works, and the practical details of working against production vs. test data. - [API Performance Tips](https://docs.virtuous.org/raise/best-practices/api-performance-tips.md): Practical techniques for keeping Raise API integrations fast and within rate-limit budgets — from caching reference data t… - [Data Modeling Best Practices](https://docs.virtuous.org/raise/best-practices/data-modeling-best-practices.md): How to structure donor, gift, and campaign data in Raise — the modeling decisions that determine how clean reporting is, h… - [Error Recovery Patterns](https://docs.virtuous.org/raise/best-practices/error-recovery-patterns.md): How Raise integrations should handle errors — classifying failures, retry strategies with backoff, circuit breakers, dead-… - [Security & Credential Management](https://docs.virtuous.org/raise/best-practices/security-and-credential-management.md): How to handle Raise API tokens, webhook secrets, and other credentials in partner integrations — secure storage, rotation,… - [Sync Architecture Patterns](https://docs.virtuous.org/raise/best-practices/sync-architecture-patterns.md): Architectural patterns for partner integrations that move data between Raise and external systems — the five patterns, whe… - [Versioning & Backward Compatibility](https://docs.virtuous.org/raise/best-practices/versioning-and-backward-compatibility.md): How Raise's unversioned API namespace shapes partner integration durability — the defensive patterns that handle spec-vs-l… - [Campaigns](https://docs.virtuous.org/raise/concepts/campaigns.md): The Campaign resource in Raise — fields, goals, sync configuration, and the special operations like replace and toggle-syn… - [How Raise Data Flows to CRM+](https://docs.virtuous.org/raise/concepts/data-flow-to-crm.md): The platform-level sync between Raise and CRM+ — what flows where, how partner integrations observe and influence it, and… - [The Raise Data Model](https://docs.virtuous.org/raise/concepts/data-model.md): The resources Raise exposes, how they relate to each other, and how data flows from a donation event through the API to do… - [Donation Forms](https://docs.virtuous.org/raise/concepts/donation-forms.md): How Donation Forms fit into the Raise data model — the form context embedded in Gift records, the personalized-page genera… - [Donors](https://docs.virtuous.org/raise/concepts/donors.md): The Donor resource in Raise — identity fields, sub-resources for addresses and contact methods, and the special operations… - [Gifts](https://docs.virtuous.org/raise/concepts/gifts.md): The Gift resource in Raise — the donation submission path through /api/Raise/give, the read-and-refund endpoint set, and t… - [Recurring Gifts](https://docs.virtuous.org/raise/concepts/recurring-gifts.md): The RecurringGift resource in Raise — the schedule that produces Gifts over time, the payment processing model, and the li… - [Statuses and Lifecycle States](https://docs.virtuous.org/raise/concepts/statuses-and-lifecycle.md): The lifecycle states across Donors, Gifts, RecurringGifts, and Campaigns in Raise — what each state means, the integer enu… - [Error Handling](https://docs.virtuous.org/raise/error-handling.md): The Raise API's error response envelope, what each status code means, and how to handle errors defensively in your integra… - [Your First API Call](https://docs.virtuous.org/raise/first-api-call.md): A deeper walkthrough of making a successful Raise API request — building the request, inspecting the response, paginating,… - [Overview](https://docs.virtuous.org/raise/overview.md): What the Raise API is, what partner integrations can build with it, and how Raise fits into the broader Virtuous platform. - [Pagination](https://docs.virtuous.org/raise/pagination.md): How Raise list and query endpoints paginate, the two filter surfaces (simple Filter parameter and advanced Query endpoints… - [Quickstart](https://docs.virtuous.org/raise/quickstart.md): The fastest path to a successful API call against Raise — from credentials to your first response in a few minutes. - [Rate Limits](https://docs.virtuous.org/raise/rate-limits.md): What's known about the Raise API's rate-limit behavior — and the defensive patterns to use given that the spec doesn't doc… - [Customize the Donation Flow](https://docs.virtuous.org/raise/recipes/customize-the-donation-flow.md): Patterns for customizing the donor's path through a Raise donation form — pre-populating donor data via URL parameters, ge… - [Embed a Form on a Website](https://docs.virtuous.org/raise/recipes/embed-a-form-on-a-website.md): An end-to-end recipe for adding a Raise donation form to a customer's website and wiring up the integration that reacts to… - [Zapier Trigger Patterns](https://docs.virtuous.org/raise/recipes/zapier-trigger-patterns.md): How the Raise–Zapier connector enables customer-facing automation, what it does and doesn't replace for partner integratio… - [Event Types](https://docs.virtuous.org/raise/webhooks/event-types.md): The Raise webhook event type catalog — the 15 documented event type integers, the resource-group pattern they follow, and… - [Idempotency and Safe Reprocessing](https://docs.virtuous.org/raise/webhooks/idempotency-and-safe-reprocessing.md): How to handle duplicate webhook deliveries in Raise — the keying strategies, deduplication storage patterns, and the opera… - [Local Testing](https://docs.virtuous.org/raise/webhooks/local-testing.md): How to develop and debug Raise webhook integrations on a local machine — tunneling, test-mode event generation, signature… - [Retry Behavior](https://docs.virtuous.org/raise/webhooks/retry-behavior.md): What Raise does when a webhook delivery fails — what's known from the webhook delivery logs, what's not documented in the… - [Signature Verification](https://docs.virtuous.org/raise/webhooks/signature-verification.md): How to verify that an incoming webhook request actually came from Raise — the securityToken-based pattern, the defensive p… - [Webhooks Overview](https://docs.virtuous.org/raise/webhooks/webhooks-overview.md): The Raise webhook system — how to subscribe to events, the delivery model, and the diagnostic tools (webhook logs) availab… - [Configure a Donation Form](https://docs.virtuous.org/raise/workflows/configure-a-donation-form.md): What partner integrations can and can't do around Donation Form configuration in Raise — and the partner-side preparation… - [Configure a Recurring Gift](https://docs.virtuous.org/raise/workflows/configure-a-recurring-gift.md): The workflow for setting up a recurring donation schedule in Raise — creation through POST /api/Raise/give with isRecurrin… - [Create or Find a Donor](https://docs.virtuous.org/raise/workflows/create-or-find-a-donor.md): The workflow for ensuring a donor record exists in Raise before submitting a donation or other donor-dependent operation —… - [Embed a Form](https://docs.virtuous.org/raise/workflows/embed-a-form.md): The workflow for placing a Raise donation form on a partner-hosted website — embed code, post-embed responsibilities, and… - [Handle Failed Payments](https://docs.virtuous.org/raise/workflows/handle-failed-payments.md): Workflows for detecting, classifying, and recovering from payment failures in Raise — covering one-time donation failures,… - [Process a Donation](https://docs.virtuous.org/raise/workflows/process-a-donation.md): The end-to-end workflow for submitting a donation through POST /api/Raise/give — the unique gift-creation path in Raise, f… - [Query Donors by Filters](https://docs.virtuous.org/raise/workflows/query-donors-by-filters.md): The workflow for reading Donors from Raise — the three lookup surfaces (search, list, query), common filter scenarios, and… - [Query Gifts by Filters](https://docs.virtuous.org/raise/workflows/query-gifts-by-filters.md): The workflow for reading Gifts from Raise with filters — the two query surfaces, the common filter scenarios, and the iter… - [Reconcile with CRM+](https://docs.virtuous.org/raise/workflows/reconcile-with-crm-plus.md): The workflow for keeping a partner integration's view of Raise data consistent with its view of CRM+ data — three reconcil… - [AI Assistant](https://docs.virtuous.org/virtuous/docs-guide/ai-assistant.md): The in-docs AI chat — ask questions, get cited answers from the Virtuous docs, attach files and images, and skip the hunt-… - [API Playground](https://docs.virtuous.org/virtuous/docs-guide/api-playground.md): The interactive endpoint pages in the docs — send real requests to CRM+, Raise, and Volunteer endpoints, see real response… - [Contextual Menu](https://docs.virtuous.org/virtuous/docs-guide/contextual-menu.md): The per-page menu that lets you copy docs as Markdown, open the current page in ChatGPT or Claude, copy the MCP server URL… - [Documentation Overview](https://docs.virtuous.org/virtuous/docs-guide/documentation-overview.md): Your orientation to the Virtuous API Docs — the four tabs, the consistent group structure within each, and how to find wha… - [Search & Navigation](https://docs.virtuous.org/virtuous/docs-guide/search-and-navigation.md): Find what you need fast — the search bar, keyboard shortcuts, table of contents, breadcrumbs, and the cross-link patterns… - [Connect to the Virtuous MCP Server](https://docs.virtuous.org/virtuous/mcp/connect.md): Setup instructions for connecting Claude, Claude Code, Cursor, VS Code, and other MCP-compatible AI tools to the Virtuous… - [MCP Overview](https://docs.virtuous.org/virtuous/mcp/overview.md): What the Virtuous Docs MCP server is, why it matters for partners building integrations, what your AI tools get access to… - [MCP Tools Reference](https://docs.virtuous.org/virtuous/mcp/tools-reference.md): The two tools the Virtuous MCP server exposes — search_virtuous_api_docs and query_docs_filesystem_virtuous_api_docs — wit… - [Using MCP for Integration Development](https://docs.virtuous.org/virtuous/mcp/using-mcp-for-integration-development.md): Practical patterns for using the Virtuous MCP server while building partner integrations — prompting techniques, day-to-da… - [Becoming a Partner](https://docs.virtuous.org/virtuous/partners/becoming-a-partner.md): How to apply to the Virtuous Partner Program, what we review, what to expect after approval, and how onboarding works for… - [Integration Pathway](https://docs.virtuous.org/virtuous/partners/integration-pathway.md): The end-to-end workflow for technology and integration partners — from MNDA signing through marketplace listing. Each mile… - [Partner Resources](https://docs.virtuous.org/virtuous/partners/partner-resources.md): The resources available to Virtuous partners — the Partner Portal, Virtuous Academy, Marketplace, referral program, co-mar… - [Partner Types & Tiers](https://docs.virtuous.org/virtuous/partners/partner-types-and-tiers.md): The three partner types in the Virtuous ecosystem — Technology & Integration, Service & Agency, and Service & Implementati… - [Partner Program Overview](https://docs.virtuous.org/virtuous/partners/program-overview.md): The Virtuous Partner Program — who partners are, what we believe about partnership, and how the ecosystem helps nonprofits… - [Authentication](https://docs.virtuous.org/volunteer/authentication.md): How to authenticate to the Volunteer API — Bearer token issuance through the VOMO admin portal, the Authorization header p… - [Base URLs & Environments](https://docs.virtuous.org/volunteer/base-urls.md): The Volunteer API base URL, the URL versioning convention, HTTPS requirements, and what's known and unknown about sandbox… - [API Performance Tips](https://docs.virtuous.org/volunteer/best-practices/api-performance-tips.md): Practical patterns for keeping Volunteer integrations fast and rate-limit-friendly — caching strategies, pagination handli… - [Data Modeling](https://docs.virtuous.org/volunteer/best-practices/data-modeling.md): How to model VOMO data inside your own systems — choosing identifiers, designing mapping tables, denormalization strategie… - [Error Recovery Patterns](https://docs.virtuous.org/volunteer/best-practices/error-recovery-patterns.md): The resilience patterns for production Volunteer integrations — classifying errors, retry strategies, circuit breakers, de… - [Security & Credential Management](https://docs.virtuous.org/volunteer/best-practices/security-and-credential-management.md): The security patterns for Volunteer integrations — token lifecycle, secure storage, scope minimization, audit logging, cus… - [Sync Architecture Patterns](https://docs.virtuous.org/volunteer/best-practices/sync-architecture-patterns.md): The high-level architectural patterns for production Volunteer integrations — initial sync, steady-state polling, reconcil… - [Versioning & Backward Compatibility](https://docs.virtuous.org/volunteer/best-practices/versioning-and-backward-compatibility.md): How to build Volunteer integrations that survive API evolution — defensive parsing, the eventual v2 overhaul, deprecation… - [Campaigns](https://docs.virtuous.org/volunteer/concepts/campaigns.md): The Campaign resource — read-only umbrella initiatives that group multiple Projects, plus the patterns for filtering and a… - [The Volunteer Data Model](https://docs.virtuous.org/volunteer/concepts/data-model.md): The eight resource families in the Volunteer API, how they relate, and the central Participation pattern that ties Users t… - [Forms & Form Completions](https://docs.virtuous.org/volunteer/concepts/forms-and-certificates.md): The Form resource family — Forms, Form Fields, Form Completions, and Field Responses. The chain that captures structured d… - [Groups](https://docs.virtuous.org/volunteer/concepts/groups.md): The Group resource reference — the most write-heavy concept in the Volunteer API. Covers fields, the seven endpoints, pare… - [Organizations & Org Family](https://docs.virtuous.org/volunteer/concepts/organizations.md): The Organization resource — the parent-child 'organization family' hierarchy, the fields the live API returns, and the pat… - [Volunteer Certificates](https://docs.virtuous.org/volunteer/concepts/participations-and-hours.md): The Certificate resource — training credentials and achievements awarded to volunteers, the naming inconsistency in the sp… - [Projects & Project Dates](https://docs.virtuous.org/volunteer/concepts/projects-and-project-dates.md): The Project (template) vs. Project Date (occurrence) distinction in detail — fields, endpoints, the Happening pattern, and… - [Users & Volunteers](https://docs.virtuous.org/volunteer/concepts/users-and-volunteers.md): The User resource reference — fields, filtering, the list vs. detail shape distinction, the upsert behavior on POST /users… - [Error Handling](https://docs.virtuous.org/volunteer/error-handling.md): How to handle errors from the Volunteer API given the sparse error documentation — the gap between spec and reality, the d… - [Your First API Call](https://docs.virtuous.org/volunteer/first-api-call.md): A guided walkthrough of a substantive Volunteer API call — fetching a single user with full detail, understanding the diff… - [Overview](https://docs.virtuous.org/volunteer/overview.md): An orientation to the Volunteer API — what VOMO is, what the API exposes, what makes it distinct from the other Virtuous A… - [Pagination & Conventions](https://docs.virtuous.org/volunteer/pagination-and-conventions.md): How pagination works in the Volunteer API — the data/links/meta envelope, page-based navigation, the follow-the-link patte… - [Change Detection Best Practices](https://docs.virtuous.org/volunteer/polling-and-sync/change-detection-best-practices.md): The cross-cutting practices for production-grade polling and reconciliation — durable checkpointing, idempotency at every… - [Detecting Project Changes](https://docs.virtuous.org/volunteer/polling-and-sync/detecting-project-changes.md): The Project-specific polling pattern — using updated_after for metadata changes, the schedule-change considerations, disti… - [Detecting User Changes](https://docs.virtuous.org/volunteer/polling-and-sync/detecting-user-changes.md): The User-specific polling pattern — using updated_after for incremental sync, handling the participation-not-captured cave… - [Reconciliation Patterns](https://docs.virtuous.org/volunteer/polling-and-sync/reconciliation-patterns.md): The slow-scan patterns that catch what polling misses — daily reconciliation against polling gaps, deletion detection with… - [Quickstart](https://docs.virtuous.org/volunteer/quickstart.md): A minimal end-to-end Volunteer API integration — obtain a token, make your first call, parse the response, and understand… - [Rate Limits](https://docs.virtuous.org/volunteer/rate-limits.md): What's known and unknown about rate limits on the Volunteer API — the spec gap, defensive patterns for partner integration… - [Build a Group from a Query](https://docs.virtuous.org/volunteer/recipes/build-a-group-from-a-query.md): The end-to-end recipe for building VOMO Groups dynamically from query results — query users by criteria, manage Group popu… - [Build a Volunteer Self-Service Portal](https://docs.virtuous.org/volunteer/recipes/build-a-volunteer-self-service-portal.md): The end-to-end recipe for a customer-facing volunteer portal — letting volunteers see their own data without VOMO admin ac… - [Combine Volunteer Data with CRM+ Data](https://docs.virtuous.org/volunteer/recipes/combine-volunteer-data-with-crm-plus-data.md): The cross-API recipe — stitching VOMO Users with CRM+ Contacts to produce unified donor-volunteer views. Matching strategi… - [Report on Volunteer Hours](https://docs.virtuous.org/volunteer/recipes/report-on-volunteer-hours.md): The end-to-end recipe for hours reporting — collecting participation data despite the lack of a direct participations endp… - [Sync Users to External System](https://docs.virtuous.org/volunteer/recipes/sync-users-to-external-system.md): The end-to-end recipe for mirroring Volunteer Users to an external system — initial backfill, steady-state polling, reconc… - [Create or Update a User](https://docs.virtuous.org/volunteer/workflows/create-or-update-a-project.md): Walk through POST /users — the upsert behavior, the 200/201 detection pattern, syncing from external systems, bulk imports… - [Create or Update a User](https://docs.virtuous.org/volunteer/workflows/create-or-update-a-user.md): Walk through POST /users — the upsert behavior, the 200/201 detection pattern, syncing from external systems, bulk imports… - [Find a User by Email](https://docs.virtuous.org/volunteer/workflows/find-a-user-by-email.md): The focused workflow for looking up a User by email — handling the email_like substring match correctly, the find-vs-upser… - [Inspect Form Completions](https://docs.virtuous.org/volunteer/workflows/inspect-form-completions.md): Walk through reading Form Completion data — paginating through a Form's completions, filtering by user or date range, join… - [List Users with Filters](https://docs.virtuous.org/volunteer/workflows/list-users-with-filters.md): Walk through GET /users with the six filter parameters — the practical patterns for recently-active queries, time-window f… - [Manage Groups and Members](https://docs.virtuous.org/volunteer/workflows/manage-groups-and-members.md): The full operational walkthrough for Groups — the only resource family with full CRUD plus dedicated member management. Co… - [Read a Project's Schedule](https://docs.virtuous.org/volunteer/workflows/read-a-projects-schedule.md): The three-endpoint pattern for reading Project scheduling data — embedded all_dates on the Project detail, the daily /proj… - [Understand Write Limitations](https://docs.virtuous.org/volunteer/workflows/understand-write-limitations.md): The explicit reference for what the Volunteer API cannot do — the complete write-surface inventory, the workarounds where… ## OpenAPI Specs - [virtuous-crm-openapi-spec-2026](https://docs.virtuous.org/virtuous-crm-openapi-spec-2026.yaml) - [RaiseAPIOpenAPI](https://docs.virtuous.org/RaiseAPIOpenAPI.json) - [api-docs-volunteer-2026](https://docs.virtuous.org/volunteer/api-docs-volunteer-2026.yaml) - [api-docs](https://docs.virtuous.org/volunteer/api-docs.json) - [virtuous_api_v1_postman](https://docs.virtuous.org/virtuous_api_v1_postman.yaml) - [swagger](https://docs.virtuous.org/swagger.json) - [postman-open-api](https://docs.virtuous.org/postman-open-api.yaml) - [openapi](https://docs.virtuous.org/api-reference/openapi.json) ## Optional - [Status](https://virtuous.org/system-status/) - [Help Center](https://virtuous.org/resources/help-center) - [Product Hub](https://product.virtuous.org/)