Get a campaign's top donors

GET

/fundraisers/{fundraiserId}/top-donors

The campaign's biggest donors, one row per person across all their paid gifts. Anonymous donors keep their total but not their name; they are identified by an opaque anonymous_key. When any donor gave in more than one currency, meta.mixed_currency is true and the totals should not be shown. Public.
Only a campaign anyone may open by link (live, ended or paused; not private; not deleted) has a public ranking. For any other campaign the answer is an empty data array, the same as for an unknown id, unless the caller is signed in as the campaign's owner or an admin.

Authorizations

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type

HTTP (bearer)

or

Parameters

Path Parameters

fundraiserId*

Type

string

Required

Format

"uuid"

Query Parameters

limit

Rows to return, clamped to 1–25.

Type

integer

Minimum

1

Maximum

25

Default

5

Responses

Top donors

Content-Type

application/json

{

"data": [

{

"id": "string",

"anonymous_key": "string",

"is_anonymous": true,

"donor_name": "string",

"donor_avatar": "string",

"total_cents": 0,

"donation_count": 0,

"last_donation_at": "string",

"currency": "string"

}

],

"meta": {

"mixed_currency": true

}

}

GET

/fundraisers/{fundraiserId}/top-donors

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

fundraiserId*

limit

Samples

Powered by VitePress OpenAPI