Skip to content

Get one badge​

GET
/achievements/{slug}

One badge with its copy, ladder and rarity. Authentication is optional: a signed-in reader also gets their own standing (earned, tier, progress). With holder_type and holder_id, the badge is answered for that holder instead (a profile's or organization's badge); both must be given together.

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

slug*
Type
string
Required

Query Parameters

holder_type
Type
string
Valid values
"user""organization"
holder_id
Type
string
Format
"uuid"
lang

Reader language; falls back to Accept-Language, then the i18next cookie, then English.

Type
string
Valid values
"en""ru""uk""es"

Responses​

The badge

application/json
JSON
{
"data": "string",
"vocabulary": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress