Query Recurring Gifts
curl --request POST \
--url https://prod-api.raisedonors.com/api/RecurringGift/query \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": "<string>",
"skip": 123,
"take": 123,
"sortBy": "createdate",
"descending": true,
"includeDetails": true,
"groups": [
{
"conditions": [
{
"parameter": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>"
]
}
]
}
],
"selectedColumns": [
"<string>"
]
}
'{
"items": [
{
"id": 123,
"organizationId": 123,
"createdDate": "<string>",
"modifiedDate": "<string>",
"profileNumber": "<string>",
"amount": 123,
"currencyCode": "<string>",
"baseCurrencyCode": "<string>",
"formattedAmount": "<string>",
"donor": {
"id": 123,
"name": "<string>",
"title": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"suffix": "<string>",
"email": "<string>",
"phone": "<string>",
"createdDate": "<string>",
"modifiedDate": "<string>",
"notes": "<string>",
"isOrganization": true,
"organizationName": "<string>",
"crmKeyUrls": {},
"crmKey": "<string>",
"crmSecondKey": "<string>",
"isTestMode": true,
"isArchived": true,
"isGDPRDeleted": true,
"primaryAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>",
"addressTypeDisplay": "<string>",
"id": 123,
"donorId": 123,
"isPrimary": true
},
"donorAddresses": [
{
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>",
"addressTypeDisplay": "<string>",
"id": 123,
"donorId": 123,
"isPrimary": true
}
],
"donorEmailAddresses": [
{
"id": 123,
"donorId": 123,
"typeDisplay": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"isPrimary": true,
"isOptedIn": true,
"isValid": true,
"isEmail": true,
"isPhone": true,
"isBounced": true,
"countryCode": "<string>"
}
],
"donorPhoneNumbers": [
{
"id": 123,
"donorId": 123,
"typeDisplay": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"isPrimary": true,
"isOptedIn": true,
"isValid": true,
"isEmail": true,
"isPhone": true,
"isBounced": true,
"countryCode": "<string>"
}
]
},
"formattedFrequency": "<string>",
"total": 123,
"formattedTotal": "<string>",
"successfulCycles": 123,
"startDate": "2023-11-07T05:31:56Z",
"startDateFormatted": "<string>",
"nextChargeDate": "2023-11-07T05:31:56Z",
"nextChargeDateFormatted": "<string>",
"nextChargeDateEditFormatted": "<string>",
"statusText": "<string>",
"gatewayId": 123,
"gateway": "<string>",
"paymentInfo": "<string>",
"expMonthAndYear": "<string>",
"cardBrand": "<string>",
"paymentMethodCountryCode": "<string>",
"projectAllocation": [
{
"projectId": 123,
"projectName": "<string>",
"amount": 123,
"formattedAmount": "<string>"
}
],
"isAnonymous": true,
"isTestMode": true,
"donorCoverCosts": true,
"motivationCode": "<string>",
"sourceCode": "<string>",
"segmentId": 123,
"segmentName": "<string>",
"segmentCode": "<string>",
"notes": "<string>",
"comments": "<string>",
"premium": {
"id": 123,
"currency": "<string>",
"name": "<string>",
"nameShort": "<string>",
"code": "<string>",
"description": "<string>",
"isActive": true,
"price": 123,
"formattedPrice": "<string>",
"fairMarketValue": 123,
"formattedFairMarketValue": "<string>",
"inventory": 123,
"keepActiveWhenHasNoInventory": true,
"recurringPremiumId": 123,
"recurringPremiumName": "<string>",
"image": "<string>",
"externalIdentifier": "<string>",
"otherMinimumAmounts": [
{
"currency": "<string>",
"value": 123
}
]
},
"recurringPremium": {
"id": 123,
"currency": "<string>",
"name": "<string>",
"nameShort": "<string>",
"code": "<string>",
"description": "<string>",
"isActive": true,
"price": 123,
"formattedPrice": "<string>",
"fairMarketValue": 123,
"formattedFairMarketValue": "<string>",
"inventory": 123,
"keepActiveWhenHasNoInventory": true,
"recurringPremiumId": 123,
"recurringPremiumName": "<string>",
"image": "<string>",
"externalIdentifier": "<string>",
"otherMinimumAmounts": [
{
"currency": "<string>",
"value": 123
}
]
},
"crmKey": "<string>",
"crmKeyUrls": {},
"page": {
"id": 123,
"name": "<string>",
"internalName": "<string>",
"internalDisplayName": "<string>",
"slug": "<string>",
"isPublished": true,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"typeDisplayName": "<string>",
"externalReferenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"json": "<string>",
"gatewayId": 123,
"merchantAccount": "<string>",
"tokenizationKey": "<string>",
"payPalGatewayId": 123,
"payPalMerchantAccount": "<string>",
"payPalTokenizationKey": "<string>",
"defaultSegmentId": 123,
"defaultSegmentName": "<string>",
"defaultSegmentCode": "<string>",
"defaultLanguage": "<string>",
"isTranslationEnabled": true,
"isAIGenerated": true,
"defaultCampaignId": 123,
"defaultProjectId": 123,
"defaultProjectName": "<string>",
"defaultProjectCode": "<string>",
"isExpireEnabled": true,
"expireDateTimeUtc": "2023-11-07T05:31:56Z",
"redirectPageId": 123,
"redirectPageName": "<string>",
"redirectUrl": "<string>",
"autoArchiveOnExpire": true,
"designSettings": {
"websiteUrl": "<string>",
"logoUrl": "<string>",
"faviconUrl": "<string>",
"primaryColor": "<string>",
"secondaryColor": "<string>",
"backgroundColor": "<string>",
"headerColor": "<string>",
"headerTextColor": "<string>",
"bodyTextColor": "<string>",
"footerColor": "<string>",
"footerTextColor": "<string>",
"buttonColor": "<string>",
"buttonTextColor": "<string>",
"buttonHoverColor": "<string>",
"buttonHoverTextColor": "<string>",
"linkColor": "<string>",
"fieldLabelColor": "<string>",
"fieldBorderColor": "<string>",
"borderRadius": "<string>",
"fontFamily": "<string>",
"globalCss": "<string>",
"globalJs": "<string>"
},
"integrations": [
{
"id": 123,
"name": "<string>",
"publicKey": "<string>"
}
],
"confirmationEmailId": 123,
"confirmationEmailName": "<string>",
"recurringEmailId": 123,
"recurringEmailName": "<string>",
"acknowledgementEmailId": 123,
"acknowledgementEmailName": "<string>",
"achSettlementConfirmationId": 123,
"achSettlementConfirmationName": "<string>",
"hasMinAmount": true,
"minAmount": 123,
"minAmountMessage": "<string>",
"hasExperiment": true,
"pageExperimentId": 123,
"createdDateTime": "<string>",
"modifiedDateTime": "<string>"
},
"merchantAccount": "<string>",
"tokenizationKey": "<string>",
"gatewayCustomerKey": "<string>",
"hasPaymentFailed": true,
"isLegacy": true,
"currencyExchange": {
"nativeAmount": "<string>",
"nativeCurrencyCode": "<string>",
"settledExchangeRate": 123,
"settledAmount": "<string>",
"settledCurrencyCode": "<string>",
"baseExchangeRate": 123,
"baseAmount": "<string>",
"baseCurrencyCode": "<string>",
"isDifferentCurrency": true
},
"tribute": {
"isInMemoryOf": true,
"isInHonorOf": true,
"nameOrOccasion": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeAddress1": "<string>",
"tributeAddress2": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"tributeCountry": "<string>",
"tributePostal": "<string>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"sendByEmail": true,
"acknowledgeeEmailAddress": "<string>",
"sendByPostal": true,
"acknowledgeeAddress1": "<string>",
"acknowledgeeAddress2": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeeCountry": "<string>",
"acknowledgeePostal": "<string>",
"message": "<string>"
},
"paymentMethodId": "<string>",
"costs": 123
}
],
"total": 123
}RecurringGift
Query Recurring Gifts
POST
https://prod-api.raisedonors.com
/
api
/
RecurringGift
/
query
Query Recurring Gifts
curl --request POST \
--url https://prod-api.raisedonors.com/api/RecurringGift/query \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": "<string>",
"skip": 123,
"take": 123,
"sortBy": "createdate",
"descending": true,
"includeDetails": true,
"groups": [
{
"conditions": [
{
"parameter": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"values": [
"<string>"
]
}
]
}
],
"selectedColumns": [
"<string>"
]
}
'{
"items": [
{
"id": 123,
"organizationId": 123,
"createdDate": "<string>",
"modifiedDate": "<string>",
"profileNumber": "<string>",
"amount": 123,
"currencyCode": "<string>",
"baseCurrencyCode": "<string>",
"formattedAmount": "<string>",
"donor": {
"id": 123,
"name": "<string>",
"title": "<string>",
"firstName": "<string>",
"middleName": "<string>",
"lastName": "<string>",
"suffix": "<string>",
"email": "<string>",
"phone": "<string>",
"createdDate": "<string>",
"modifiedDate": "<string>",
"notes": "<string>",
"isOrganization": true,
"organizationName": "<string>",
"crmKeyUrls": {},
"crmKey": "<string>",
"crmSecondKey": "<string>",
"isTestMode": true,
"isArchived": true,
"isGDPRDeleted": true,
"primaryAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>",
"addressTypeDisplay": "<string>",
"id": 123,
"donorId": 123,
"isPrimary": true
},
"donorAddresses": [
{
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>",
"addressTypeDisplay": "<string>",
"id": 123,
"donorId": 123,
"isPrimary": true
}
],
"donorEmailAddresses": [
{
"id": 123,
"donorId": 123,
"typeDisplay": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"isPrimary": true,
"isOptedIn": true,
"isValid": true,
"isEmail": true,
"isPhone": true,
"isBounced": true,
"countryCode": "<string>"
}
],
"donorPhoneNumbers": [
{
"id": 123,
"donorId": 123,
"typeDisplay": "<string>",
"value": "<string>",
"secondaryValue": "<string>",
"isPrimary": true,
"isOptedIn": true,
"isValid": true,
"isEmail": true,
"isPhone": true,
"isBounced": true,
"countryCode": "<string>"
}
]
},
"formattedFrequency": "<string>",
"total": 123,
"formattedTotal": "<string>",
"successfulCycles": 123,
"startDate": "2023-11-07T05:31:56Z",
"startDateFormatted": "<string>",
"nextChargeDate": "2023-11-07T05:31:56Z",
"nextChargeDateFormatted": "<string>",
"nextChargeDateEditFormatted": "<string>",
"statusText": "<string>",
"gatewayId": 123,
"gateway": "<string>",
"paymentInfo": "<string>",
"expMonthAndYear": "<string>",
"cardBrand": "<string>",
"paymentMethodCountryCode": "<string>",
"projectAllocation": [
{
"projectId": 123,
"projectName": "<string>",
"amount": 123,
"formattedAmount": "<string>"
}
],
"isAnonymous": true,
"isTestMode": true,
"donorCoverCosts": true,
"motivationCode": "<string>",
"sourceCode": "<string>",
"segmentId": 123,
"segmentName": "<string>",
"segmentCode": "<string>",
"notes": "<string>",
"comments": "<string>",
"premium": {
"id": 123,
"currency": "<string>",
"name": "<string>",
"nameShort": "<string>",
"code": "<string>",
"description": "<string>",
"isActive": true,
"price": 123,
"formattedPrice": "<string>",
"fairMarketValue": 123,
"formattedFairMarketValue": "<string>",
"inventory": 123,
"keepActiveWhenHasNoInventory": true,
"recurringPremiumId": 123,
"recurringPremiumName": "<string>",
"image": "<string>",
"externalIdentifier": "<string>",
"otherMinimumAmounts": [
{
"currency": "<string>",
"value": 123
}
]
},
"recurringPremium": {
"id": 123,
"currency": "<string>",
"name": "<string>",
"nameShort": "<string>",
"code": "<string>",
"description": "<string>",
"isActive": true,
"price": 123,
"formattedPrice": "<string>",
"fairMarketValue": 123,
"formattedFairMarketValue": "<string>",
"inventory": 123,
"keepActiveWhenHasNoInventory": true,
"recurringPremiumId": 123,
"recurringPremiumName": "<string>",
"image": "<string>",
"externalIdentifier": "<string>",
"otherMinimumAmounts": [
{
"currency": "<string>",
"value": 123
}
]
},
"crmKey": "<string>",
"crmKeyUrls": {},
"page": {
"id": 123,
"name": "<string>",
"internalName": "<string>",
"internalDisplayName": "<string>",
"slug": "<string>",
"isPublished": true,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"typeDisplayName": "<string>",
"externalReferenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"json": "<string>",
"gatewayId": 123,
"merchantAccount": "<string>",
"tokenizationKey": "<string>",
"payPalGatewayId": 123,
"payPalMerchantAccount": "<string>",
"payPalTokenizationKey": "<string>",
"defaultSegmentId": 123,
"defaultSegmentName": "<string>",
"defaultSegmentCode": "<string>",
"defaultLanguage": "<string>",
"isTranslationEnabled": true,
"isAIGenerated": true,
"defaultCampaignId": 123,
"defaultProjectId": 123,
"defaultProjectName": "<string>",
"defaultProjectCode": "<string>",
"isExpireEnabled": true,
"expireDateTimeUtc": "2023-11-07T05:31:56Z",
"redirectPageId": 123,
"redirectPageName": "<string>",
"redirectUrl": "<string>",
"autoArchiveOnExpire": true,
"designSettings": {
"websiteUrl": "<string>",
"logoUrl": "<string>",
"faviconUrl": "<string>",
"primaryColor": "<string>",
"secondaryColor": "<string>",
"backgroundColor": "<string>",
"headerColor": "<string>",
"headerTextColor": "<string>",
"bodyTextColor": "<string>",
"footerColor": "<string>",
"footerTextColor": "<string>",
"buttonColor": "<string>",
"buttonTextColor": "<string>",
"buttonHoverColor": "<string>",
"buttonHoverTextColor": "<string>",
"linkColor": "<string>",
"fieldLabelColor": "<string>",
"fieldBorderColor": "<string>",
"borderRadius": "<string>",
"fontFamily": "<string>",
"globalCss": "<string>",
"globalJs": "<string>"
},
"integrations": [
{
"id": 123,
"name": "<string>",
"publicKey": "<string>"
}
],
"confirmationEmailId": 123,
"confirmationEmailName": "<string>",
"recurringEmailId": 123,
"recurringEmailName": "<string>",
"acknowledgementEmailId": 123,
"acknowledgementEmailName": "<string>",
"achSettlementConfirmationId": 123,
"achSettlementConfirmationName": "<string>",
"hasMinAmount": true,
"minAmount": 123,
"minAmountMessage": "<string>",
"hasExperiment": true,
"pageExperimentId": 123,
"createdDateTime": "<string>",
"modifiedDateTime": "<string>"
},
"merchantAccount": "<string>",
"tokenizationKey": "<string>",
"gatewayCustomerKey": "<string>",
"hasPaymentFailed": true,
"isLegacy": true,
"currencyExchange": {
"nativeAmount": "<string>",
"nativeCurrencyCode": "<string>",
"settledExchangeRate": 123,
"settledAmount": "<string>",
"settledCurrencyCode": "<string>",
"baseExchangeRate": 123,
"baseAmount": "<string>",
"baseCurrencyCode": "<string>",
"isDifferentCurrency": true
},
"tribute": {
"isInMemoryOf": true,
"isInHonorOf": true,
"nameOrOccasion": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeAddress1": "<string>",
"tributeAddress2": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"tributeCountry": "<string>",
"tributePostal": "<string>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"sendByEmail": true,
"acknowledgeeEmailAddress": "<string>",
"sendByPostal": true,
"acknowledgeeAddress1": "<string>",
"acknowledgeeAddress2": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeeCountry": "<string>",
"acknowledgeePostal": "<string>",
"message": "<string>"
},
"paymentMethodId": "<string>",
"costs": 123
}
],
"total": 123
}Authorizations
JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
Body
application/jsontext/jsonapplication/*+json
The query request model.
- Option 1
- Option 2
Request body for advanced query endpoints such as donor and campaign queries.
Field to sort by (case-insensitive). Valid options: createdate, createddatetime, email, firstname, gifts, giftsum, id, lastname, modifieddatetimeutc, name, phone
Available options:
createdate, createddatetime, email, firstname, gifts, giftsum, id, lastname, modifieddatetimeutc, name, phone Example:
"createdate"
The logical type of query being executed.
Available options:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9 The groups of conditions that make up the query.
Show child attributes
Show child attributes
The list of result columns to return for each item.
Last modified on June 5, 2026
Was this page helpful?
⌘I