Get organization dashboard totals

GET

/org-admin/{slug}/overview

Headline numbers for the org-admin dashboard. For a conglomerate the figures roll up the organization and all of its child organizations; for a company they cover the organization alone. totalRaisedCents sums every paid donation on those organizations' fundraisers, in integer cents. uniqueDonors counts distinct signed-in donors only — guest donations do not add to it.

Requires permission: org.read

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

Responses

Dashboard totals

Content-Type

application/json

{

"data": {

"activeFundraisers": 0,

"totalFundraisers": 0,

"totalRaisedCents": 4560000,

"uniqueDonors": 0,

"kind": "string",

"childrenCount": 0

}

}

GET

/org-admin/{slug}/overview

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

slug*

Samples

Powered by VitePress OpenAPI