Query donors based on specified criteria.

POST

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

POST

/api/Donor/query

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

{
  "items": [
    {
      "id": 1024,
      "name": "John A. Smith",
      "title": "Mr.",
      "firstName": "John",
      "middleName": "Allen",
      "lastName": "Smith",
      "suffix": "Jr.",
      "email": "john.smith@example.org",
      "phone": "+1-555-123-4567",
      "createdDate": "2023-11-15T09:30:00Z",
      "modifiedDate": "2024-05-20T14:45:00Z",
      "notes": "Preferred contact time: afternoons. Interested in monthly newsletters.",
      "isOrganization": false,
      "organizationName": "",
      "crmKeyUrls": {},
      "crmKey": "CRM123456789",
      "crmSecondKey": "ALT987654321",
      "isTestMode": false,
      "isArchived": false,
      "isGDPRDeleted": false,
      "primaryAddress": {
        "address1": "123 Maple Street",
        "address2": "Apt 4B",
        "addressType": 1,
        "addressTypeDisplay": "Home",
        "city": "Springfield",
        "countryString": "USA",
        "donorId": 1024,
        "id": 501,
        "isPrimary": true,
        "postal": "62704",
        "state": "IL"
      },
      "donorAddresses": [
        {
          "address1": "123 Maple Street",
          "address2": "Apt 4B",
          "addressType": 1,
          "addressTypeDisplay": "Home",
          "city": "Springfield",
          "countryString": "USA",
          "donorId": 1024,
          "id": 501,
          "isPrimary": true,
          "postal": "62704",
          "state": "IL"
        },
        {
          "address1": "456 Oak Avenue",
          "address2": "",
          "addressType": 2,
          "addressTypeDisplay": "Work",
          "city": "Chicago",
          "countryString": "USA",
          "donorId": 1024,
          "id": 502,
          "isPrimary": false,
          "postal": "60616",
          "state": "IL"
        }
      ],
      "donorEmailAddresses": [
        {
          "id": 301,
          "donorId": 1024,
          "type": 10,
          "typeDisplay": "Personal Email",
          "value": "john.smith@example.org",
          "secondaryValue": "",
          "isPrimary": true,
          "isOptedIn": true,
          "isValid": true,
          "isEmail": true,
          "isPhone": false,
          "isBounced": false,
          "countryCode": "US"
        },
        {
          "id": 302,
          "donorId": 1024,
          "type": 11,
          "typeDisplay": "Work Email",
          "value": "j.smith@company.com",
          "secondaryValue": "",
          "isPrimary": false,
          "isOptedIn": false,
          "isValid": true,
          "isEmail": true,
          "isPhone": false,
          "isBounced": false,
          "countryCode": "US"
        }
      ],
      "donorPhoneNumbers": [
        {
          "id": 401,
          "donorId": 1024,
          "type": 20,
          "typeDisplay": "Mobile",
          "value": "+1-555-123-4567",
          "secondaryValue": "",
          "isPrimary": true,
          "isOptedIn": true,
          "isValid": true,
          "isEmail": false,
          "isPhone": true,
          "isBounced": false,
          "countryCode": "US"
        },
        {
          "id": 402,
          "donorId": 1024,
          "type": 21,
          "typeDisplay": "Home Phone",
          "value": "+1-555-765-4321",
          "secondaryValue": "",
          "isPrimary": false,
          "isOptedIn": false,
          "isValid": true,
          "isEmail": false,
          "isPhone": true,
          "isBounced": false,
          "countryCode": "US"
        }
      ]
    }
  ],
  "total": 1
}

When includeDetails=true, the response includes all related entities (DonorAddresses, DonorContactMethods) 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 donor 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