Skip to main content
GET
Get Contributions

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 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"

minimumInitiatedDate
string<date-time>

The minimum date the contributions were initiated to return.

Example:

"2025-01-01"

maximumInitiatedDate
string<date-time>

The maximum date the contributions were initiated to return.

Example:

"2025-02-01"

statusBucket
enum<string>[]

Filter contributions by status buckets.

Available options:
CANCELED,
CONFIRMED,
PENDING,
FAILED
Example:
campaignId
string

Filter by campaign id.

subcampaignId
string

Filter by subcampaign id.

locationIds
string[]

Filter by location ids.

Filter by giving link id.

pledgeId
string

Filter by pledge id.

Response

200 - application/json
data
object[]
required

List of contributions.

totalCount
number
required

Total number of contributions matching the filters.

Example:

100

Last modified on July 14, 2026