Skip to content

Get my reveal pack​

GET
/me/achievements/reveals

Cards waiting to be "opened": with receipt, the ones a particular donation earned (the thank-you page — status: pending while the award is still being computed); with all=true, every unrevealed card. Pass exactly one. Someone else's receipt answers like a donation that earned nothing (status: none). Responses are private, no-store.

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​

Query Parameters

receipt

A Stripe PaymentIntent id.

Type
string
Pattern
"^pi_[A-Za-z0-9_]{1,255}$"
all
Type
string
Valid values
"true"

Responses​

The pack

application/json
JSON
{
"data": {
"status": "string",
"events": [
{
"id": 0,
"event_ids": [
0
],
"kind": "string",
"tier": {
"key": "string",
"label": "string"
},
"from_tier": {
"key": "string",
"label": "string"
},
"revealed": true,
"card": {
"additionalProperties": "string"
},
"tierup_line": "string"
}
]
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress