Skip to main content
GET
/
api
/
v3
/
donors
Get Donors
curl --request GET \
  --url https://server.stage.overflow.co/api/v3/donors \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'
{
  "data": [
    {
      "id": "6710f34fd5061afeec3eab57",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "+1234567890",
      "address": {
        "line1": "123 Main St",
        "line2": "Apt 1",
        "city": "Anytown",
        "state": "CA",
        "zip": "12345"
      },
      "activeRecurringCount": 1,
      "latestContributionDate": "2025-01-01T00:00:00.000",
      "locationIds": [
        "6710f34fd5061afeec3eab57"
      ],
      "totalContributionsCount": 10
    }
  ],
  "totalCount": 100
}

Documentation Index

Fetch the complete documentation index at: https://docs.overflow.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-client-id
string
header
required

Client ID for API authentication

​
x-api-key
string
header
required

API Key for API authentication

Query Parameters

​
limit
number
default:25

The number of donors to return

Required range: 1 <= x <= 100
​
locationIds
string[]

Filter donors by location IDs

Example:
["6710f34fd5061afeec3eab57"]
​
maximumUpdatedDate
string<date-time>

The maximum updated date of the donors to return.

Example:

"2025-02-01"

​
minimumUpdatedDate
string<date-time>

The minimum updated date of the donors to return.

Example:

"2025-01-01"

​
page
number
default:1

The page number of the donors to return

Required range: x >= 1
​
sortBy
enum<string>
default:updatedAt

The field to sort the donors by.

Available options:
createdAt,
updatedAt,
firstName,
lastName,
email,
phone,
id,
totalContributionsCount
Example:

"createdAt"

​
sortDirection
enum<string>
default:DESC

The direction to sort the donors by.

Available options:
ASC,
DESC
Example:

"DESC"

Response

200 - application/json
​
data
object[]
required

List of donors

​
totalCount
number
required

Total number of donors matching the filters

Example:

100