Skip to content

Get one of a sponsor's perks​

GET
/sponsors/{key}/perks/{perkId}

One perk with where it works in store (each place's state today and any closure ahead), when it went live, and the viewer's eligibility. 404 for a perk of another sponsor, one the public doesn't see, or any perk of a closed sponsor.

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​

Path Parameters

key*

The sponsor's slug, a slug it used to have, or its id.

Type
string
Required
perkId*
Type
string
Required
Format
"uuid"

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress