virtuous_get_current_organization
Get the current organization
Fetch the Virtuous organization this API key acts in — its name, time zone and culture, and whether the key's user is an administrator. A cheap way to confirm the key works. Virtuous: GET /api/Organization/Current.
Takes no parameters.
virtuous_search
Global search
Full-text search across contacts, individuals and entities (campaigns, projects, segments, tags) — the same search as the Virtuous search bar. Returns hits with highlights, grouped by kind. Virtuous: POST /api/Search.
Parametersskiptakequeryrequiredfilter_types
virtuous_search_contacts
Search contacts
Find contacts whose name, email, phone or address fully or partially matches a search string. Returns id, name, contact type, email, phone and address per match. Virtuous: POST /api/Contact/Search.
Parametersskiptakesearchrequired
virtuous_get_contact
Get a contact
Fetch one contact (household, organization, foundation ...) with its address, giving summary (life-to-date, year-to-date, last gift), individuals and their contact methods, and custom fields. Virtuous: GET /api/Contact/{contactId}.
Parameterscontact_idrequired
virtuous_find_contact
Find a contact by email or reference
Look up a single contact by email address, or by an external reference (reference source + id, e.g. Stripe customer id). Give either email, or both reference_source and reference_id; if both are given Virtuous prioritises the reference. Virtuous: GET /api/Contact/Find.
Parametersemailreference_idreference_source
virtuous_list_contact_individuals
List a contact's individuals
List the individuals (people) that belong to a contact/household, with names, birth dates, and their emails and phones (contact methods). Virtuous: GET /api/ContactIndividual/ByContact/{contactId}.
Parameterscontact_idrequired
virtuous_list_contact_notes
List a contact's notes
List the notes logged on a contact — calls, meetings, emails and other touchpoints — with type, date, text and author. Virtuous: GET /api/ContactNote/ByContact/{contactId}.
Parametersskiptakesort_bycontact_idrequireddescending
virtuous_list_contact_note_types
List contact note types
List the note types this organization accepts on a contact note (e.g. Call, Email, Visit; admins can add custom ones). Call it before virtuous_create_contact_note and pass one of these names as its type. Virtuous: GET /api/ContactNote/Types.
Takes no parameters.
virtuous_list_contact_tags
List a contact's tags
List the tags applied to a contact (contactTagId, tagId, name). Virtuous: GET /api/ContactTag/ByContact/{contactId}.
Parametersskiptakecontact_idrequired
virtuous_list_contact_gifts
List a contact's gifts
List a contact's giving history: gift id, type, date, amount, segment and batch. Use virtuous_get_gift for designations and full detail. Virtuous: GET /api/Gift/ByContact/{contactId}.
Parametersskiptakesort_bycontact_idrequireddescending
virtuous_get_gift
Get a gift
Fetch one gift in full: contact, type, date, amount and currency, batch, segment, grant, tribute, receipt date, designations to projects, premiums and custom fields. Virtuous: GET /api/Gift/{giftId}.
Parametersgift_idrequired
virtuous_list_tags
List tags
List the organization's tags (id, name, tag group). Use this to find a tagId before virtuous_add_contact_tag. Virtuous: GET /api/Tag.
Parametersskiptake
virtuous_search_projects
Search projects
Find projects (funds / designations gifts are given to) by name or code, with their balances, financial need and life-to-date giving. Virtuous: POST /api/Project/Search.
Parametersskiptakesearchrequired
virtuous_get_project
Get a project
Fetch one project: code, type, status, balances, financial need, date range, life-to-date and calendar-year giving and gift/giver counts. Virtuous: GET /api/Project/{projectId}.
Parametersproject_idrequired
virtuous_list_events
List events
List the organization's events: name, type, location, start/end, invite and RSVP counts, attendance and total giving. Virtuous: GET /api/Event.
Parametersskiptake
virtuous_get_query_options
Get query options
List the parameters, their types, allowed operators and value options that virtuous_query accepts for one record type. Call this BEFORE building a query. Virtuous: GET /api/<Resource>/QueryOptions.
Parametersresourcerequired
virtuous_query
Query records
Run a Virtuous query-builder query against one record type (contacts, gifts, campaigns, projects, tasks, grants, pledges, recurring gifts, events ...). Conditions use parameter/operator names from virtuous_get_query_options. Returns { list, total }. For Contact and Gift, full_details returns full records instead of the abbreviated view. Virtuous: POST /api/<Resource>/Query.
Parametersskiptakegroupssort_byresourcerequireddescendingfull_detailsinclude_archived
virtuous_create_contact_note
Log a note on a contact
Add a note to a contact's timeline — a call, meeting, visit or other touchpoint. Writes to the donor record. Get the valid type names from virtuous_list_contact_note_types first. Virtuous: POST /api/ContactNote.
Parametersnoterequiredtypeprivateimportantcontact_idrequiredtime_spentnote_date_time
virtuous_add_contact_tag
Tag a contact
Apply an existing tag to a contact (find the tagId with virtuous_list_tags). Virtuous: POST /api/ContactTag.
Parameterstag_idrequiredcontact_idrequired
virtuous_create_contact_transaction
Submit a contact for import
Submit a new or updated contact through Virtuous's import pipeline (the recommended way to add contacts). It is matched against existing contacts by name, email, phone, address and reference, bundled into an import at midnight, and only committed when a user reviews the import and clicks Run — so nothing is created in real time and no duplicates are forced. Virtuous: POST /api/Contact/Transaction.
Parameterscitynametagsemailphonestatetitlepostalsuffixcountryaddress1address2+11 more
virtuous_create_gift_transaction
Submit a gift for import
Record a gift (donation already received) through Virtuous's gift import pipeline — the method Virtuous recommends. The gift is matched to a contact, recurring gift or pledge, held until the nightly import, and only created when a user reviews the import and clicks Run. This records a gift; it does NOT charge anyone. Identify the donor with contact.id, contact.referenceId, or name/email details. Virtuous: POST /api/v2/Gift/Transaction.
Parametersbatchnotesamountrequiredcontactrequiredsegmentfrequencygift_daterequiredgift_typerequiredis_privatecheck_numberdesignationsreceipt_date+5 more