For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

API Reference SDKs

Skip to navigation

Virtuous CRM+Campaigns

Communication Query Options

GET

/api/Communication/QueryOptions

GET

/api/Communication/QueryOptions

curl https://api.virtuoussoftware.com/api/Communication/QueryOptions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

200Retrieved

{}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK

Was this page helpful?

Get the Segments for a Contact

API Reference SDKs

Virtuous CRM+
Virtuous Raise
Virtuous Volunteer

Get Token
Get the Organizations the current user belongs to
Get the Current Organization for the current user
Switch the Current Organization
Get Permissions for the current user
Get a Contact
Update a Contact
Get a Contact by Reference Source and ID
Get a Contact by Reference ID
Get Contacts by Tag ID
Find a Contact by Email Address or Reference Source and ID
Find all Contacts that match, fully or partially, the given search parameters
Find all Contacts within a given proximity of a geocoordinate
Get the Activity for the Contacts the current user is following
Get the Contacts the current user is following
Create a Contact
Archive a Contact
Unarchive a Contact
Follow or Unfollow a Contact for the current user
Get Custom Collections for Contacts
Create Collection for a Contact
Update Collection for a Contact
Delete Collection for a Contact
Create a Contact that will go through the import process
Create a Contact Import that will be processed for changes and duplicates
Get Contact Name Prefixes and Titles
Get Contact Types
Get Contact Custom Fields Available
Get Contact Query Options
Query Contacts with Abbreviated Details
Query Contacts with Full Details
Receipts
Get Receipt
Get Individuals for a Contact
Get an Individual
Update an Individual
Delete an Individual
Find an individual by email address
Gets the avatar for a specified contact individual
Upload the avatar for an Individual
Create an Individual
Get Custom Collections for Individuals
Create Collection for an Individual
Update Collection for an Individual
Delete Collection for an Individual
Gets the custom fields for contact individuals
Get Individual Query Options
Query Individuals
Get Email Lists for an Individual
Get the Contact Addresses for a Contact
Get a Contact Address
Update a Contact Address
Delete a Contact Address
Create a Contact Address
Archive a Contact Address
Unarchive a Contact Address
Get Contact Method Types
Get Contact Methods Types related to the Base Type
Get a Contact Method
Update a Contact Method
Delete a Contact Method
Create a Contact Method for an Individual
Archive a Contact Method
Unarchive a Contact Method
Get the Notes for a Contact
Get the Important Notes for a Contact
Get a Note
Update a Note
Delete a Note
Create a Note for a Contact
Create a Note using an Email
Get Contact Note Query Options
Query Contact Notes
Get Contact Note Types
Gets the custom fields for contact note
Create a Contact Reference
Delete a Contact Reference
Get all Tags
Find all Tags that match, fully or partially
Get Tags for a Contact
Create a Contact Tag
Delete a Contact Tag
Get all Organization Groups
Get Organization Groups for a Contact
Get the Contacts in an Organization Group
Get an Organization Group
Assign a Contact to an Organization Group
Remove a Contact from an Organization Group
Get Relationships for a Contact
Create a Relationship
Update a Relationship
Delete a Relationship
Get Relationship Types
Search for Tributes
Create a Tribute
Update a Tribute
Get Gifts for a Contact
Get Gifts for a Contact by Reference ID
Get Passthrough Gifts for a Contact
Get a Gift
Update a Gift
Delete a Gift
Get a Gift by Transaction Source and ID
Create a Gift *not recommended*
Update many Gifts
Create many Gifts *not recommended*
Create a Reversing Transaction
Create a Gift Transaction
Create a Batch of Gift Transactions
Get Gift Custom Fields Available
Get Non-Cash Gift Types Available
Get Gift Query Options
Query Gifts with Abbreviated Details
Query Gifts with Full Details
Get Gift Designation Query Options
Query Gift Designations
Get Gift Asks for a Contact
Get the Gifts applied to a Gift Ask
Get a Gift Ask
Update a Gift Ask
Create a Gift Ask
Get Gift Ask Custom Fields Available
Get Gift Ask Query Options
Query Gift Asks
Get Planned Gifts for a Contact
Get Planned Gift
Update a Planned Gift
Get Gifts Applied to a Planned Gift
Create a Planned Gift
Get Planned Gift Custom Fields Available
Get Planned Gift Query Options
Query Planned Gifts
Get Pledges for a Contact
Get Pledge
Update a Pledge
Create a Pledge
Write-off the Pledge
Get Pledge Custom Fields Available
Get Pledge Query Options
Query Pledges
Get Premium
Update a Premium
Get Premium using a unique Code
Find Premiums
Create a Premium
Increment the inventory count
Decrement the inventory count
Get Premium Custom Fields Available
Query Premiums
Get Premium Query Options
Get Recurring Gifts for a Contact
Get a Recurring Gift
Update a Recurring Gift
Create a Recurring Gift
Cancel a Recurring Gift
Get Recurring Gift Custom Fields Available
Get Recurring Gift Query Options
Query Recurring Gifts
Get Payments for a Recurring Gift
Get Campaign
Gets Campaign Steps
Get Campaign Query Options
Query Campaigns
Get Communications for a Campaign
Get Communication
Get Channel Types
Get Communication Types
Create Communication
Query Communications
Communication Query Options
Get the Segments for a Contact
Get a Segment
Update a Segment
Get a Segment using a unique Code
Find Segments
Create a Segment
Get Project
Update a Project
Get a Project using a unique Code
Find Projects
Create a Project
Update many Projects
Temporarily Change Project Inventory Status
Update Project Balance
Get Project Custom Fields Available
Get Project Types
Get Project Query Options
Query Projects
Get Project Expenses for a Project
Create a Project Expense
Get Project Expense
Update a Project Expense
Create many Project Expenses
Get Notes for a Project
Get Project Note
Update a Project Note
Delete a Project Note
Create a Project Note
Get Project Note Types
Get Project Roles for a Contact
Get Project Roles for a Project
Get Project Role
Update a Project Role
Delete a Project Role
Create a Project Role
Get Project Role Types
Get Events
Create an Event
Get an Event
Update an Event
Delete an Event
Find an Event
Get the Event Types
Get Event Custom Fields Available
Get Event Query Options
Query Events
Get Event Attendees for an Event
Create an Event Attendee
Get an Event Attendee
Update an Event Attendee
Delete an Event Attendee
Get Event Attendee Custom Fields Available
Get Event Attendee Query Options
Query Event Attendees
Get Event Contacts for an Event
Create an Event Contact
Get an Event Contact
Delete an Event Contact
Get Grants for a Contact
Get Grant
Update a Grant
Delete a Grant
Get a Grant by Reference ID
Get the Gifts applied to a Grant
Create a Grant
Get Grant Custom Fields Available
Get Grant Query Options
Query Grants
Get Volunteer Opportunities
Create a Volunteer Opportunity
Get Volunteer Opportunity
Update a Volunteer Opportunity
Delete a Volunteer Opportunity
Get Custom Fields Available
Queries Volunteer Opportunities
Get Volunteers for a Volunteer Opportunity
Create a Volunteer
Get Volunteer
Delete a Volunteer
Search for Volunteers
Get Query Options
Query Volunteers
Get Volunteer Attendance for a Volunteer
Create a Volunteer Attendance
Get Volunteer Attendance
Update a Volunteer Attendance
Delete a Volunteer Attendance
Get Volunteer Organizers
Create a Volunteer Organizer
Get Volunteer Organizer
Delete a Volunteer Organizer
Get Emails
Send an Email to a list of Contacts
Search for an Email List
Add Individuals to an Email List
Get Active Reminders (for current user)
Get Saved Reminders (for current user)
Get Active Manual Reminders by Contact
Get Inactive Manual Reminders by Contact
Get Unresolved Manual Reminders by Contact
Create Manual Reminder
Create Recurring Reminder
Create Milestone Reminder
Update Recurring Reminder
Update Milestone Reminder.
Complete Reminder
Dismiss Reminder
Get Reminder Types
Get Reminder Source Types
Gets Milestone Types
Gets Reminder Frequency Types
Search for Contacts, Individuals or Entities
Create a Task
Get Task Types
Query Tasks
Get Task Query Options
Get a Webhook
Update a Webhook
Delete a Webhook
Create a Webhook
Set the active state of a Webhook
Get a paginated list of donor activities across the organization.
Listcampaigns
Get a campaign by ID.
Update a campaign.
Delete a campaign.
Create a new campaign.
Get the count of dependencies for a campaign.
Replace a campaign with another campaign for its dependencies.
Toggle the sync status of a campaign.
Query campaigns based on specified criteria.
Get a paginated list of custom fields.
Get a custom field by its ID.
Update an existing custom field.
Delete a custom field by its ID.
Create a new custom field.
Get the dependency count for a custom field.
Get a donor by ID.
Getdonorlist
Query donors based on specified criteria.
Search for donors by a filter string. Can match on donor ID, first name, last name, organization name, phone number, email address, postal code, and state. Supports searching by first/last name combinations, name with state, name with postal code, phone number in (xxx) xxx-xxxx format, and email in angle brackets.
Update an existing donor (full update).
Partially update an existing donor.
Archive a donor.
Merge two donors.
Update the notes for a donor.
Get a specific donor address by ID.
Partially update a donor address. Only provided fields will be updated.
Create a new donor address.
Update an existing donor address.
Delete a donor address.
Get a list of addresses for a donor.
Set a donor address as the primary address. This will unmark any other address as primary.
Get a donor contact method by ID.
Update an existing donor contact method.
Delete a donor contact method.
Partially update an existing donor contact method (PATCH).
Create a new donor contact method.
Set a donor contact method as primary.
Gets a paginated list of donor's contact methods.
Gets a paginated list of donor's email addresses.
Gets a paginated list of donor's phone numbers.
Create a new email address for a donor.
Update an existing email address.
Partially update an existing email address (PATCH).
Set an email address as primary.
Create a new phone number for a donor.
Update an existing phone number.
Partially update an existing phone number (PATCH).
Set a phone number as primary.
Gets a paginated list of the custom field responses for a donor.
Getdonorresponses
Gets a paginated list of the gifts for a donor.
Gets a paginated list of the recurring gifts for a donor.
Create a new donor activity.
Get a paginated list of the activities for a donor.
Gets a paginated list of the projects for a donor.
Get the campaign statistics for a donor.
Get the motivation statistics for a donor.
Get the segment statistics for a donor.
Transfer a gift to another donor.
Transfer a recurring gift to another donor.
Generates a personalized hosted donation page for a donor based on their giving history. Loads donor context (giving history, projects) and delegates to Raise.AI.Services.DonorPageCreationService for AI-powered page creation and personalization. The page is published and sent to Virtuous Giving for hosting.
Search
Getgiftlist
Get a gift by its ID.
Delete a gift by its ID.
Query gifts based on the specified filter.
Get custom field responses for a gift.
Refunds a gift by its ID. This endpoint processes the refund through the payment provider and updates the gift status accordingly. It also sends a refund notification email to the donor.
Update the notes for a gift.
Getmotivationcodelist
Getmotivationcodebyid
Updatemotivationcode
Createmotivationcode
Getmotivationcodegrouplist
Getmotivationcodegroupbyid
Updatemotivationcodegroup
Deletemotivationcodegroup
Createmotivationcodegroup
Get all active knowledge sources for the current organization.
Create a new knowledge source and queue it for indexing.
Get a knowledge source by ID.
Update a knowledge source and queue it for re-indexing.
Delete a knowledge source and remove it from the search index.
Force re-index a knowledge source.
Upload a document file to blob storage for a knowledge source. Returns the blob path to use when creating/updating a Document knowledge source.
Get a paginated list of premiums.
Get a premium by its ID.
Update an existing premium.
Delete a premium by its ID.
Create a new premium.
Get all the dependency counts that will be affected by deactivating a premium.
Deactivate a premium by its ID with a request model.
Get a paginated list of projects.
Get a project by ID.
Gets a project by its unique code.
Create a new project.
Update an existing project.
Delete a project by its ID.
Get donors for a specific project.
Get gifts for a specific project.
Get the dependency count for a specific project.
Replace a project with a new one.
Query donors based on specified criteria.
Verify if a project code exists in Raise or any connected CRM integrations.
Returns a list of saved queries for the specified query type.
Creates a new query for the current user.
Updates an existing query by ID.
Deletes a query by ID.
Looks up available options for a query parameter for the specified query type.
Parses a query string for the specified query type and returns the parsed query structure.
Returns all available query parameters, operators, and result fields for the specified query type.
Payments the specified request.
Gets the costs.
Generates a test payment method for testing purposes.
Lead
Get a paginated list of recurring gifts.
Query recurring gifts based on the specified criteria.
Get a specific recurring gift by ID.
Update a specific recurring gift.
List activities associated with a specific recurring gift.
Cancel a specific recurring gift.
List segments with optional campaign filter and pagination.
Verify if a segment with the specified code exists.
Get a specific segment by ID.
Update a specific segment.
Delete a specific segment.
Create a new segment.
Replace a segment with a new one.
Get a paginated list of donors for a segment.
Get a paginated list of gifts for a segment.
Get the page dependency count for a specific segment.
Query segments based on the specified query request model.
Get a specific webhook by ID.
Update a specific webhook.
Delete a specific webhook.
Get a paginated list of webhooks.
Create a new webhook.
Get a paginated list of webhook logs.
Get a paginated list of logs for a specific webhook.
Get a specific log for a webhook.
Subscribes Zapier to receive webhook notifications for a specific event type. Creates a new webhook in Raise Donors that will send notifications to Zapier's target URL.
Unsubscribes Zapier from receiving webhook notifications by deleting the webhook.
Test endpoint for Zapier to verify the connection and authentication.
Retrieves sample records for a specific event type to use in Zapier trigger testing. Returns recent records that match the event type for testing purposes.
List / find Campaigns
Get Campaign Details
Get all certifications
Get all forms
Get all completions for a form
Get a single form completion
Get all groups
Create New Group
Get A Group
Update A Group
Delete A Group
Get Group Members
Update A Group's Members
Get details for organizations in your organizations family
Get Organization Details
List / find Projects
Create a Project
Get Project Details
Update a Project
Get Project Date Details
List of Projects and Volunteers for today.
List / find Users
Create / Update User
Get User Details