Search for donors by a filter string. Can match on donor ID, first name, last name, organization name, phone number, email address, postal code, and state. Supports searching by first/last name combinations, name with state, name with postal code, phone number in (xxx) xxx-xxxx format, and email in angle brackets.

[
  {
    "id": 10234,
    "crmKey": "CRM-2024-000123",
    "name": "John Smith",
    "title": "Mr.",
    "firstName": "John",
    "lastName": "Smith",
    "suffix": "Jr.",
    "email": "john.smith@example.org",
    "phone": "(555) 123-4567",
    "isOrganization": false,
    "organizationName": null,
    "notes": "Preferred contact time: afternoons",
    "primaryAddress": {
      "address1": "123 Elm Street",
      "address2": "Apt 4B",
      "addressType": 1,
      "addressTypeDisplay": "Home",
      "city": "Springfield",
      "countryString": "USA",
      "donorId": 10234,
      "id": 5678,
      "isPrimary": true,
      "postal": "62704",
      "state": "IL"
    }
  }
]

Authentication

Authorizationstring

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

Query parameters

filterstringOptional

The search term to match against donor fields. Can be ID, name, email, phone, address, or combinations.

Response

idlongOptional

Gets or sets the identifier.

crmKeystring or nullOptional

Gets or sets the crmkey.

namestring or nullOptional

Gets or sets the name.

titlestring or nullOptional

Gets or sets the title.

firstNamestring or nullOptional

Gets or sets the first name.

lastNamestring or nullOptional

Gets or sets the last name.

suffixstring or nullOptional

Gets or sets the suffix.

emailstring or nullOptional

Gets or sets the email address.

phonestring or nullOptional

Gets or sets the phone.

isOrganizationbooleanOptional

Gets or sets a value indicating whether organization.

organizationNamestring or nullOptional

Gets or sets the organization name.

notesstring or nullOptional

Gets or sets any additional notes.

primaryAddressobject or nullOptional

Gets or sets the address.

Errors

400

Bad Request Error