Read a donor and their gifts

GET

/org-admin/{slug}/donors/{donorId}

The donorId is an organization-owned paid donation id anchoring the donor identity. Arbitrary account ids cannot be used to browse profiles. Totals are grouped by currency. Requires organization permission org.read_donors.

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*

Organization slug; middleware resolves and authorizes this organization before any read or write.

Type

string

Required

donorId*

Type

string

Required

Format

"uuid"

Responses

Successful organization-scoped response

Content-Type

application/json

{

"data": {

"donor_key": "string",

"donor_detail_id": "string",

"follower_user_id": "string",

"donor_display_name": "string",

"donor_avatar": "string",

"donor_email": "string",

"donor_city": "string",

"is_anonymous": true,

"is_following": true,

"donation_count": 0,

"totals": [

{

"currency": "string",

"amount_cents": 0

}

],

"last_donated_at": "string"

}

}

GET

/org-admin/{slug}/donors/{donorId}

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

slug*

donorId*

Samples

Powered by VitePress OpenAPI