Get Donor

Get Donor

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/donors/{donorId} \
  --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": "[email protected]",
    "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",
    "totalContributionsCount": 10
  }
}

GET

api

donors

{donorId}

Get Donor

curl --request GET \
  --url https://server.stage.overflow.co/api/v3/donors/{donorId} \
  --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": "[email protected]",
    "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",
    "totalContributionsCount": 10
  }
}

Authorizations

x-client-id

string

header

required

Client ID for API authentication

Path Parameters

donorId

string

required

The ID of the donor to fetch.

Example:

"2ea1ae03ca521e437db76d76"

Response

data

object

required

The donor for the given ID

Show child attributes

data.id

string

required

Donor Id

Example:

"6710f34fd5061afeec3eab57"

data.createdAt

string<date-time>

required

Donor created at

Example:

"2025-01-01T00:00:00.000Z"

data.updatedAt

string<date-time>

required

Donor updated at

Example:

"2025-01-01T00:00:00.000Z"

data.firstName

string

required

Donor first name

Example:

"John"

data.lastName

string

required

Donor last name

Example:

"Doe"

data.email

string<email>

required

Donor email

Example:

"[email protected]"

data.phone

string

required

Donor phone number in E.164 format

Example:

"+1234567890"

data.address

object

required

Donor address

Show child attributes

data.address.city

string

required

Minimum string length: 1

data.address.line1

string

required

Minimum string length: 1

data.address.state

string

required

Minimum string length: 1

data.address.zip

string

required

data.address.country

string

data.address.line2

string

data.address.timezone

string

Example:

{
  "line1": "123 Main St",
  "line2": "Apt 1",
  "city": "Anytown",
  "state": "CA",
  "zip": "12345"
}

data.activeRecurringCount

number

The number of active recurring donations

Example:

1

data.latestContributionDate

string<date-time>

The date of the latest contribution

Example:

"2025-01-01T00:00:00.000"

data.totalContributionsCount

number

Total number of contributions made by the donor

Example:

10

Create Donor Profile Update Donor

⌘I

Start Here

Contributions

Donors

Subscriptions

Payment Methods

Campaigns

Status

Authorizations

Path Parameters

Response