Skip to content

List donors and followers​

GET
/org-admin/{slug}/users

Distinct named donors and public followers are combined once per account. Guest and anonymous gift identities remain separate. Follower-only records have zero gifts and no email or donation date. Gift filters match the donor's gifts while returned totals retain their entire organization history. 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

Query Parameters

q

Search visible name, registered donor gift email or public city. Guest receipt emails are excluded.

Type
string
Max Length
128
dateFrom

Inclusive gift creation timestamp.

Type
string
Format
"date-time"
dateTo

Inclusive gift creation timestamp.

Type
string
Format
"date-time"
amount

Exact gift amount in major units, without currency symbols.

Type
string
Pattern
"^\\d{1,10}(\\.\\d{1,2})?$"
fundraiser

Fundraiser title contains this text.

Type
string
Max Length
128
following

Following, not following, or not applicable for guest/anonymous records.

Type
string
Valid values
"yes""no""na"
limit
Type
integer
Minimum
1
Maximum
100
Default
25
offset
Type
integer
Minimum
0
Default
0

Responses​

Successful organization-scoped response

application/json
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"
}
],
"pagination": {
"total": 0,
"limit": 0,
"offset": 0
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress