Skip to main content
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

Authorization
string
header
required

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

Path Parameters

contactId
string
required

(Required) The contact identifier.

Query Parameters

sortBy
string

The field to be sorted. Supported: Id, RecurringGiftDate, Amount, CreatedDateTime.

descending
string

The direction to be sorted.

skip
string

The number of records to skip. Default = 0.

take
string

The number of records to take. Default = 10.

Response

200 - application/json

OK

list
object[]
total
string
Last modified on June 5, 2026