Skip to content

How many people could use it​

GET
/sponsors/{key}/manage/perks/estimate

People whose city is the sponsor's home city holding the tier or higher. Fewer than 10 is never a number.

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

key*

The sponsor's slug (an old slug resolves too) or id.

Type
string
Required

Query Parameters

achievement_id*
Type
string
Required
Format
"uuid"
tier_id*
Type
string
Required
Format
"uuid"

Responses​

OK

application/json
JSON
{
"city": {
"additionalProperties": "string"
},
"holders": 0,
"fewer_than": 0
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress