Skip to content

List donations to the organization's fundraisers​

GET
/org-admin/{slug}/donations

Donations to this organization's non-deleted fundraisers, newest first, with offset pagination. Every payment status is returned unless status narrows it.

Donor privacy: donor_display_name is Anonymous donor when the gift was marked anonymous, the donor's profile name for a signed-in donor, and the checkout name for a guest. Donor email addresses are never returned.

Requires permission: org.read_donations

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)

Parameters​

Path Parameters

slug*

The organization's slug (not its UUID).

Type
string
Required
Example"local-food-bank-a1b2c3"
Pattern
"^[a-z0-9][a-z0-9-]{0,254}$"

Query Parameters

status

Only donations with this payment status. Send one of the listed values.

Type
string
Valid values
"paid""pending""failed""refunded"
fundraiser_id

Only donations to this fundraiser. Must be a UUID.

Type
string
Format
"uuid"
limit

Clamped to 1..100. Defaults to 20.

Type
integer
Minimum
1
Maximum
100
Default
20
offset
Type
integer
Minimum
0
Default
0

Responses​

Paginated donations

application/json
JSON
{
"data": [
],
"pagination": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress