Get Recurring Gifts for a Contact
curl --request GET \
--url https://api.virtuoussoftware.com/api/RecurringGift/ByContact/{contactId} \
--header 'Authorization: Bearer <token>'{
"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
Get Recurring Gifts for a Contact
GET
/
api
/
RecurringGift
/
ByContact
/
{contactId}
Get Recurring Gifts for a Contact
curl --request GET \
--url https://api.virtuoussoftware.com/api/RecurringGift/ByContact/{contactId} \
--header 'Authorization: Bearer <token>'{
"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.
Path Parameters
(Required) The contact identifier.
Query Parameters
The field to be sorted. Supported: Id, RecurringGiftDate, Amount, CreatedDateTime.
The direction to be sorted.
The number of records to skip. Default = 0.
The number of records to take. Default = 10.
Last modified on June 5, 2026
Was this page helpful?
⌘I