Skip to content

Get a profile's achievements​

GET
/users/{id}/achievements

The achievements section of a profile: the badges the person has earned that visitors may see, each with its card, plus a public holder block, a summary counted over the returned rows, the profile's pinned card and the label vocabulary. id is a UUID or a profile slug.

The answer is the same for everyone, the owner included, except that the owner's own rows carry their counts (stats). A private or inactive profile read by anyone but its owner answers { "data": [], "withheld": true, "vocabulary": … }.

Authentication is optional. Rate limited at 300 requests/minute per IP.

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

id*

Profile UUID or profile slug.

Type
string
Required

Query Parameters

lang

Locale for titles and labels; unsupported locales fall back to English.

Type
string

Responses​

The collection, or a withheld answer

application/json
JSON
{
"data": [
],
"withheld": true,
"holder": "string",
"summary": {
"additionalProperties": "string"
},
"pin": "string",
"vocabulary": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress