Query Recurring Gifts
curl --request POST \
--url https://api.virtuoussoftware.com/api/RecurringGift/Query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groups": [
{
"conditions": [
{
"parameter": "<string>",
"operator": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>",
"<string>"
]
},
{
"parameter": "<string>",
"operator": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>",
"<string>"
]
}
]
},
{
"conditions": [
{
"parameter": "<string>",
"operator": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>",
"<string>"
]
},
{
"parameter": "<string>",
"operator": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>",
"<string>"
]
}
]
}
],
"sortBy": "<string>",
"descending": "<boolean>"
}
'{
"list": [
{
"id": "<integer>",
"transactionSource": "<string>",
"transactionId": "<string>",
"contactId": "<integer>",
"startDate": "<dateTime>",
"amount": "<double>",
"frequency": "<string>",
"anticipatedEndDate": "<dateTime>",
"cancelDateTimeUtc": "<dateTime>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentUrl": "<string>",
"automatedPayments": "<boolean>",
"trackPayments": "<boolean>",
"isPrivate": "<boolean>",
"status": "<string>",
"nextExpectedPaymentDate": "<dateTime>",
"designations": [
{
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"projectCode": "<string>"
},
{
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"projectCode": "<string>"
}
],
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
},
{
"id": "<integer>",
"transactionSource": "<string>",
"transactionId": "<string>",
"contactId": "<integer>",
"startDate": "<dateTime>",
"amount": "<double>",
"frequency": "<string>",
"anticipatedEndDate": "<dateTime>",
"cancelDateTimeUtc": "<dateTime>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentUrl": "<string>",
"automatedPayments": "<boolean>",
"trackPayments": "<boolean>",
"isPrivate": "<boolean>",
"status": "<string>",
"nextExpectedPaymentDate": "<dateTime>",
"designations": [
{
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"projectCode": "<string>"
},
{
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"projectCode": "<string>"
}
],
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
],
"total": "<integer>"
}Recurring Gifts
Query Recurring Gifts
POST
/
api
/
RecurringGift
/
Query
Query Recurring Gifts
curl --request POST \
--url https://api.virtuoussoftware.com/api/RecurringGift/Query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groups": [
{
"conditions": [
{
"parameter": "<string>",
"operator": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>",
"<string>"
]
},
{
"parameter": "<string>",
"operator": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>",
"<string>"
]
}
]
},
{
"conditions": [
{
"parameter": "<string>",
"operator": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>",
"<string>"
]
},
{
"parameter": "<string>",
"operator": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>",
"<string>"
]
}
]
}
],
"sortBy": "<string>",
"descending": "<boolean>"
}
'{
"list": [
{
"id": "<integer>",
"transactionSource": "<string>",
"transactionId": "<string>",
"contactId": "<integer>",
"startDate": "<dateTime>",
"amount": "<double>",
"frequency": "<string>",
"anticipatedEndDate": "<dateTime>",
"cancelDateTimeUtc": "<dateTime>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentUrl": "<string>",
"automatedPayments": "<boolean>",
"trackPayments": "<boolean>",
"isPrivate": "<boolean>",
"status": "<string>",
"nextExpectedPaymentDate": "<dateTime>",
"designations": [
{
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"projectCode": "<string>"
},
{
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"projectCode": "<string>"
}
],
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
},
{
"id": "<integer>",
"transactionSource": "<string>",
"transactionId": "<string>",
"contactId": "<integer>",
"startDate": "<dateTime>",
"amount": "<double>",
"frequency": "<string>",
"anticipatedEndDate": "<dateTime>",
"cancelDateTimeUtc": "<dateTime>",
"createDateTimeUtc": "<dateTime>",
"createdByUser": "<string>",
"modifiedDateTimeUtc": "<dateTime>",
"modifiedByUser": "<string>",
"segmentId": "<integer>",
"segment": "<string>",
"segmentUrl": "<string>",
"automatedPayments": "<boolean>",
"trackPayments": "<boolean>",
"isPrivate": "<boolean>",
"status": "<string>",
"nextExpectedPaymentDate": "<dateTime>",
"designations": [
{
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"projectCode": "<string>"
},
{
"projectId": "<integer>",
"project": "<string>",
"projectUrl": "<string>",
"amountDesignated": "<double>",
"projectCode": "<string>"
}
],
"customFields": [
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
},
{
"name": "<string>",
"value": "<string>",
"displayName": "<string>"
}
]
}
],
"total": "<integer>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The number of records to skip. Default = 0.
The number of records to take. Default = 10. Max is 1000.
Last modified on June 5, 2026
Was this page helpful?
⌘I