Skip to content

The perk builder's options​

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

The achievements perks may be for, giving achievements first (the tracks in the vocabulary's order), with their tiers and thresholds, optional canonical art (AchievementArt), what a threshold counts (unit, and the noun by plural form in units, as in "10 donations") and, in the reader's language, their title, tagline and how to earn them; the open locations (a storefront with its street, each with its city), the category and the rules (10 live, 14 days, $25).

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

Responses​

OK

application/json
JSON
{
"achievements": [
{
"id": "string",
"slug": "string",
"title": "string",
"art": "string",
"additionalProperties": "string"
}
],
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress