Get a user's Impact and leaderboard rank

GET

/users/{id}/impact

The figures behind the Impact stat on a public profile, read from the same all-time field /leaderboard is served from, so the two surfaces always agree. Accepts a UUID or a profile_slug. All money is integer cents. A user who has not moved money answers zeroes and a null rank rather than 404 — their referral impressions are still reported. A private profile answers its headline impact figure only, with the rest of the breakdown zeroed and rank null, to everybody but its owner. If the leaderboard field cannot be read the endpoint answers 200 with zeroes rather than failing the profile.

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

id*

Type

string

Required

Responses

The user's Impact breakdown

Content-Type

application/json

{

"impact": {

"rank": 0,

"impact": 0,

"raised": 0,

"given": 0,

"driven": 0,

"impressions": 0,

"gifts": 0

}

}

GET

/users/{id}/impact

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

id*

Samples

Powered by VitePress OpenAPI