Skip to content

Perks for one achievement card​

GET
/sponsors/perks

The perks of listed sponsors for one achievement, split at a card's tier: unlocks are the perks for that tier and below, higher counts the perks of each tier above with two examples, never how far the holder is from it. The card's code and QR are public and never unlock a perk; for a signed-in holder each perk carries their own eligibility.

Authorizations​

or
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

achievement*

The achievement's slug or id.

Type
string
Required
tier
Type
string
Valid values
"base""bronze""silver""gold"
Default
"base"
city
Type
string
near
Type
string
limit
Type
integer
Default
4
Maximum
24

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress