Skip to main content
GET
/
api
/
v3
/
contributions
Get Contributions
curl --request GET \
  --url https://server.stage.overflow.co/api/v3/contributions \
  --header 'x-client-id: <api-key>'
{
  "data": [
    {
      "id": "6710f34fd5061afeec3eab57",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z",
      "type": "CASH",
      "amount": 1000,
      "contributionDate": "2025-01-01T00:00:00.000Z",
      "contributionReceivedAt": "2023-11-07T05:31:56Z",
      "liquidationInitiatedAt": null,
      "receivedTokensAt": null,
      "status": "PAID_OUT",
      "stocks": {
        "quantity": 2,
        "tickers": [
          "AAPL",
          "MSFT"
        ]
      },
      "crypto": {
        "quantity": 1,
        "token": "BTC"
      },
      "frequency": "one-time",
      "paymentMethod": {
        "type": "Card",
        "logoUrl": "https://example.com/logo.png",
        "last4": "4242"
      },
      "depositId": "8810f34fd5061afeec3eab67",
      "campaign": {
        "id": "7710f34fd5061afeec3eab78",
        "name": "Mission 2025"
      },
      "subcampaign": {
        "id": "7710f34fd5061afeec3eab79",
        "name": "Toy Drive"
      },
      "dedication": "In memory of Lois Lane",
      "donorNotes": "Happy to support this cause!",
      "donor": {
        "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
      },
      "donorCoveredFees": false,
      "subscriptionId": "6710f34fd5061afeec3eab57",
      "anonymous": false
    }
  ],
  "totalCount": 100
}

Authorizations

​
x-client-id
string
header
required

Client ID for API authentication

Query Parameters

​
limit
number
default:25

The number of contributions to return.

Required range: 1 <= x <= 100
​
page
number
default:1

The page number of the contributions to return.

Required range: x >= 1
​
minimumUpdatedDate
string<date-time>

The minimum updated date of the contributions to return.

Example:

"2025-01-01"

​
maximumUpdatedDate
string<date-time>

The maximum updated date of the contributions to return.

Example:

"2025-02-01"

​
statusBucket
enum<string>[]

Filter contributions by status buckets.

Available options:
CANCELED,
CONFIRMED,
PENDING,
FAILED
Example:
["PENDING", "CONFIRMED"]
​
campaignId
string

Filter by campaign id.

​
subcampaignId
string

Filter by subcampaign id.

Response

200 - application/json
​
data
object[]
required

List of contributions.

​
totalCount
number
required

Total number of contributions matching the filters.

Example:

100