Query recurring gifts based on the specified criteria.

POST

https://prod-api.raisedonors.com/api/RecurringGift/query

POST

/api/RecurringGift/query

curl -X POST https://prod-api.raisedonors.com/api/RecurringGift/query \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "items": [
    {
      "id": 1,
      "organizationId": 1,
      "createdDate": "string",
      "modifiedDate": "string",
      "profileNumber": "string",
      "amount": 1.1,
      "currencyCode": "string",
      "baseCurrencyCode": "string",
      "formattedAmount": "string",
      "donor": {
        "id": 1,
        "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",
          "addressType": 0,
          "addressTypeDisplay": "string",
          "city": "string",
          "countryString": "string",
          "donorId": 1,
          "id": 1,
          "isPrimary": true,
          "postal": "string",
          "state": "string"
        },
        "donorAddresses": [
          {
            "address1": "string",
            "address2": "string",
            "addressType": 0,
            "addressTypeDisplay": "string",
            "city": "string",
            "countryString": "string",
            "donorId": 1,
            "id": 1,
            "isPrimary": true,
            "postal": "string",
            "state": "string"
          }
        ],
        "donorEmailAddresses": [
          {
            "id": 1,
            "donorId": 1,
            "type": 0,
            "typeDisplay": "string",
            "value": "string",
            "secondaryValue": "string",
            "isPrimary": true,
            "isOptedIn": true,
            "isValid": true,
            "isEmail": true,
            "isPhone": true,
            "isBounced": true,
            "countryCode": "string"
          }
        ],
        "donorPhoneNumbers": [
          {
            "id": 1,
            "donorId": 1,
            "type": 0,
            "typeDisplay": "string",
            "value": "string",
            "secondaryValue": "string",
            "isPrimary": true,
            "isOptedIn": true,
            "isValid": true,
            "isEmail": true,
            "isPhone": true,
            "isBounced": true,
            "countryCode": "string"
          }
        ]
      },
      "frequency": 0,
      "formattedFrequency": "string",
      "total": 1.1,
      "formattedTotal": "string",
      "successfulCycles": 1,
      "startDate": "2024-01-15T09:30:00Z",
      "startDateFormatted": "string",
      "nextChargeDate": "2024-01-15T09:30:00Z",
      "nextChargeDateFormatted": "string",
      "nextChargeDateEditFormatted": "string",
      "status": 1,
      "statusText": "string",
      "gatewayId": 1,
      "gateway": "string",
      "paymentInfo": "string",
      "expMonthAndYear": "string",
      "cardBrand": "string",
      "paymentMethodCountryCode": "string",
      "projectAllocation": [
        {
          "projectId": 1,
          "projectName": "string",
          "amount": 1.1,
          "formattedAmount": "string"
        }
      ],
      "isAnonymous": true,
      "isTestMode": true,
      "donorCoverCosts": true,
      "motivationCode": "string",
      "sourceCode": "string",
      "segmentId": 1,
      "segmentName": "string",
      "segmentCode": "string",
      "notes": "string",
      "comments": "string",
      "premium": {
        "id": 1,
        "currency": "string",
        "name": "string",
        "nameShort": "string",
        "code": "string",
        "description": "string",
        "isActive": true,
        "price": 1.1,
        "formattedPrice": "string",
        "fairMarketValue": 1.1,
        "formattedFairMarketValue": "string",
        "inventory": 1,
        "keepActiveWhenHasNoInventory": true,
        "recurringPremiumId": 1,
        "recurringPremiumName": "string",
        "image": "string",
        "externalIdentifier": "string",
        "otherMinimumAmounts": [
          {
            "currency": "string",
            "value": 1.1
          }
        ]
      },
      "recurringPremium": {
        "id": 1,
        "currency": "string",
        "name": "string",
        "nameShort": "string",
        "code": "string",
        "description": "string",
        "isActive": true,
        "price": 1.1,
        "formattedPrice": "string",
        "fairMarketValue": 1.1,
        "formattedFairMarketValue": "string",
        "inventory": 1,
        "keepActiveWhenHasNoInventory": true,
        "recurringPremiumId": 1,
        "recurringPremiumName": "string",
        "image": "string",
        "externalIdentifier": "string",
        "otherMinimumAmounts": [
          {
            "currency": "string",
            "value": 1.1
          }
        ]
      },
      "paymentProviderType": 0,
      "crmKey": "string",
      "crmKeyUrls": {},
      "page": {
        "id": 1,
        "name": "string",
        "internalName": "string",
        "internalDisplayName": "string",
        "slug": "string",
        "isPublished": true,
        "publicId": "string",
        "type": 0,
        "typeDisplayName": "string",
        "formType": 0,
        "externalReferenceId": "string",
        "json": "string",
        "gatewayId": 1,
        "merchantAccount": "string",
        "merchantType": 0,
        "tokenizationKey": "string",
        "payPalGatewayId": 1,
        "payPalMerchantAccount": "string",
        "payPalTokenizationKey": "string",
        "defaultSegmentId": 1,
        "defaultSegmentName": "string",
        "defaultSegmentCode": "string",
        "defaultLanguage": "string",
        "isTranslationEnabled": true,
        "isAIGenerated": true,
        "defaultCampaignId": 1,
        "defaultProjectId": 1,
        "defaultProjectName": "string",
        "defaultProjectCode": "string",
        "isExpireEnabled": true,
        "expireDateTimeUtc": "2024-01-15T09:30:00Z",
        "redirectPageId": 1,
        "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": 1,
            "name": "string",
            "publicKey": "string",
            "integrationType": 0
          }
        ],
        "confirmationEmailId": 1,
        "confirmationEmailName": "string",
        "recurringEmailId": 1,
        "recurringEmailName": "string",
        "acknowledgementEmailId": 1,
        "acknowledgementEmailName": "string",
        "achSettlementConfirmationId": 1,
        "achSettlementConfirmationName": "string",
        "hasMinAmount": true,
        "minAmount": 1.1,
        "minAmountMessage": "string",
        "hasExperiment": true,
        "pageExperimentId": 1,
        "experimentStatus": 0,
        "createdDateTime": "string",
        "modifiedDateTime": "string"
      },
      "merchantType": 0,
      "merchantAccount": "string",
      "tokenizationKey": "string",
      "paymentTenderType": 0,
      "gatewayCustomerKey": "string",
      "hasPaymentFailed": true,
      "isLegacy": true,
      "currencyExchange": {
        "nativeAmount": "string",
        "nativeCurrencyCode": "string",
        "settledExchangeRate": 1.1,
        "settledAmount": "string",
        "settledCurrencyCode": "string",
        "baseExchangeRate": 1.1,
        "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": 1.1
    }
  ],
  "total": 1
}

Authentication

Authorizationstring

JWT Authorization header using the Bearer scheme. Example: “Authorization: Bearer {token}”

Request

The query request model.

QueryRequestModelobjectRequired

Request body for advanced query endpoints such as donor and campaign queries.

ParsedQueryResponseModelobjectRequired

Represents a parsedquery response model.

Response

itemslist of objectsOptional

totalintegerOptional

Errors

400

Bad Request Error