Skip to content

My perks​

GET
/me/perks

The signed-in person's perks at listed sponsors. ready: perks they qualify for (they hold the tier and its 7 days have passed), including ones used as often as they allow; other: perks for a tier they don't hold yet, or hold but still wait out; saved; used: their counted uses, newest first. counts covers every tab, unlocking groups the tiers whose wait is running with the day it ends. Perks of a sponsor they work for are never ready or other. With "Show sponsor perks" off (show_sponsor_perks in the user's preferences) ready and other are empty and perksOff is true.

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

tab
Type
string
Valid values
"ready""other""saved""used"
Default
"ready"
city

A city's slug, or all. Absent: the person's own city.

Type
string
category
Type
string
online

Just the perks used online.

Type
string
Valid values
"true""1"
near

lat,lng to sort from. Without it, the person's own place.

Type
string
limit
Type
integer
Default
20
Maximum
50
offset
Type
integer
Default
0

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress