Get my ambassador standing
GET
/me/referrals/standing
The caller's rank among ambassadors by money raised in the window, and the leaderboard (up to 200 rows; truncated when there are more). Other ambassadors with private profiles appear without name or avatar.
Requires permission: view_own_referral_portal.
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
Query Parameters
from
Window start. Defaults to 28 days before to. Must be before to and not earlier than 2020-01-01.
Type
string
Format
"date-time"to
Window end. Defaults to now.
Type
string
Format
"date-time"Responses
The standing
application/json
JSON
{
"data": {
"rank": 0,
"total_ambassadors": 0,
"leaderboard": [
{
"rank": 0,
"ambassador_user_id": "string",
"display_name": "string",
"avatar_url": "string",
"raised_cents": 0,
"driven_gifts": 0,
"is_me": true
}
],
"truncated": true
},
"range": "string"
}