Getdonorlist

GET

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

GET

/api/Donor/list

curl -G https://prod-api.raisedonors.com/api/Donor/list \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d SortBy=createdate

{
  "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 donor, interested in monthly giving.",
      "isOrganization": false,
      "organizationName": null,
      "crmKeyUrls": {
        "Salesforce": {
          "crmKey": "SF123456",
          "url": "https://salesforce.com/donor/1024"
        },
        "HubSpot": {
          "crmKey": "HS78910",
          "url": "https://app.hubspot.com/contacts/1024"
        }
      },
      "crmKey": "CRM-1024-ABCD",
      "crmSecondKey": "CRM-SECOND-5678",
      "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"
        }
      ],
      "donorEmailAddresses": [
        {
          "id": 301,
          "donorId": 1024,
          "type": 10,
          "typeDisplay": "Personal Email",
          "value": "john.smith@example.org",
          "secondaryValue": null,
          "isPrimary": true,
          "isOptedIn": true,
          "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": null,
          "isPrimary": true,
          "isOptedIn": true,
          "isValid": true,
          "isEmail": false,
          "isPhone": true,
          "isBounced": false,
          "countryCode": "US"
        }
      ]
    }
  ],
  "total": 1
}

Authentication

Authorizationstring

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

Query parameters

FilterstringOptional

SkipintegerOptional

TakeintegerOptional

SortByenumOptional

Field to sort by (case-insensitive). Valid options: createdate, createddatetime, email, firstname, gifts, giftsum, id, lastname, modifieddatetimeutc, name, phone

DescendingbooleanOptional

IncludeDetailsbooleanOptional

Response

itemslist of objectsOptional

totalintegerOptional

Errors

400

Bad Request Error