Query gifts based on the specified filter.

POST

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

POST

/api/Gift/query

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

{
  "items": [
    {
      "id": 1,
      "currency": "string",
      "amount": 1.1,
      "formattedAmount": "string",
      "date": "string",
      "createdDate": "string",
      "modifiedDate": "string",
      "status": 0,
      "statusText": "string",
      "gateway": "string",
      "authorizationNumber": "string",
      "transactionId": "string",
      "donationId": "string",
      "paymentInfo": "string",
      "paymentType": "string",
      "segment": "string",
      "motivation": "string",
      "campaignName": "string",
      "segmentName": "string",
      "notes": "string",
      "comment": "string",
      "donorId": 1,
      "billingName": "string",
      "shippingName": "string",
      "recurringGiftId": 1,
      "giftAidRequested": true,
      "canRefund": true,
      "donorPaidCosts": true,
      "paymentProviderTransactionUrl": "string",
      "submissionUrl": "string",
      "billingAddress": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "postal": "string",
        "countryString": "string",
        "addressType": 0,
        "addressTypeDisplay": "string"
      },
      "shippingAddress": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "postal": "string",
        "countryString": "string",
        "addressType": 0,
        "addressTypeDisplay": "string"
      },
      "projects": [
        {
          "projectId": 1,
          "name": "string",
          "amount": "string",
          "currencyExchange": {
            "nativeAmount": "string",
            "nativeCurrencyCode": "string",
            "settledExchangeRate": 1.1,
            "settledAmount": "string",
            "settledCurrencyCode": "string",
            "baseExchangeRate": 1.1,
            "baseAmount": "string",
            "baseCurrencyCode": "string",
            "isDifferentCurrency": true
          }
        }
      ],
      "browserInfo": {
        "name": "string",
        "version": "string",
        "platform": "string",
        "userAgent": "string",
        "javaScriptVersion": "string",
        "isBeta": true,
        "isCrawler": true,
        "supportsCookies": true,
        "supportsJavaApplets": true,
        "supportsActiveXControls": true
      },
      "premiumItem": {
        "qualifies": true,
        "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
            }
          ]
        }
      },
      "form": {
        "id": 1,
        "title": "string",
        "landingUrl": "string",
        "referringUrl": "string",
        "isLegacy": true
      },
      "donorStatistic": {
        "totalGift": "string",
        "totalGiftAmount": "string",
        "lastGift": {
          "id": 1,
          "date": "string",
          "amount": "string",
          "paymentInfo": "string",
          "donorId": 1,
          "donorImage": "string",
          "donorName": "string",
          "donorEmail": "string",
          "form": "string",
          "projects": [
            {
              "projectId": 1,
              "name": "string",
              "amount": "string",
              "currencyExchange": {
                "nativeAmount": "string",
                "nativeCurrencyCode": "string",
                "settledExchangeRate": 1.1,
                "settledAmount": "string",
                "settledCurrencyCode": "string",
                "baseExchangeRate": 1.1,
                "baseAmount": "string",
                "baseCurrencyCode": "string",
                "isDifferentCurrency": true
              }
            }
          ],
          "status": 0,
          "statusText": "string",
          "donorIsGDPRDeleted": true,
          "isAnonymous": true,
          "canRefund": true,
          "transactionId": "string",
          "isTribute": true,
          "isFromTerminal": true,
          "donorPaidCosts": true,
          "metadata": [
            "string"
          ],
          "segmentCode": "string",
          "currencyExchange": {
            "nativeAmount": "string",
            "nativeCurrencyCode": "string",
            "settledExchangeRate": 1.1,
            "settledAmount": "string",
            "settledCurrencyCode": "string",
            "baseExchangeRate": 1.1,
            "baseAmount": "string",
            "baseCurrencyCode": "string",
            "isDifferentCurrency": true
          }
        },
        "lastGiftAmount": "string"
      },
      "recurringScheduleInfo": {
        "amount": "string",
        "currencyCode": "string",
        "frequency": "string",
        "status": 1,
        "statusText": "string",
        "successfulCycles": 1,
        "startDate": "string",
        "nextCharge": "string",
        "currentCharge": "string",
        "previousCharge": "string",
        "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,
        "sendByEmail": true,
        "sendByPostal": true,
        "tributeFirstName": "string",
        "tributeLastName": "string",
        "tributeAddress": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "string",
          "postal": "string",
          "countryString": "string",
          "addressType": 0,
          "addressTypeDisplay": "string"
        },
        "acknowledgeeFirstName": "string",
        "acknowledgeeLastName": "string",
        "acknowledgeeAddress": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "string",
          "postal": "string",
          "countryString": "string",
          "addressType": 0,
          "addressTypeDisplay": "string"
        },
        "acknowledgeeEmailAddress": "string",
        "message": "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"
          }
        ]
      },
      "isAnonymous": true,
      "isTestMode": true,
      "virtualTerminalId": 1,
      "virtualTerminal": "string",
      "googleUtmCampaign": "string",
      "googleUtmContent": "string",
      "googleUtmMedium": "string",
      "googleUtmSource": "string",
      "googleUtmTerm": "string",
      "googleUtmId": "string",
      "googleGclid": "string",
      "motivationCodeGroupId": 1,
      "motivationCodeGroupName": "string",
      "motivationCodeId": 1,
      "motivationCodeName": "string",
      "currencyExchange": {
        "nativeAmount": "string",
        "nativeCurrencyCode": "string",
        "settledExchangeRate": 1.1,
        "settledAmount": "string",
        "settledCurrencyCode": "string",
        "baseExchangeRate": 1.1,
        "baseAmount": "string",
        "baseCurrencyCode": "string",
        "isDifferentCurrency": true
      }
    }
  ],
  "total": 1
}

When includeDetails=true, the response includes all related entities (Donor, Gateway, Segment, etc.) similar to the GET by ID endpoint. This may impact performance for large result sets.

Authentication

Authorizationstring

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

Request

The gift query request, including structured groups/conditions, selectedColumns, includeDetails, and paging options.

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