Skip to content

Perks used​

GET
/sponsors/{key}/manage/uses

The four totals (today, this week, this month, all time: uses that count and the people who used them: "givers thanked" from 5 up all time, "fewer than 10" under 10 otherwise) and the uses themselves, newest first, in the sponsor's home time zone. Never who. Managers see their locations. Cashiers see today at theirs, with today's total alone and no draft perks in the filter. Online uses belong to no location, so only those who see every location see them.

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​

Path Parameters

key*

The sponsor's slug, an old slug, or its id.

Type
string
Required

Query Parameters

range

recent is today and yesterday; yesterday is yesterday alone, in the home city. A cashier always gets today.

Type
string
Valid values
"recent""today""yesterday""week""month""all""custom"
Default
"recent"
from

With range=custom.

Type
string
Format
"date"
to

With range=custom.

Type
string
Format
"date"
location

A location id

Type
string
perk
Type
string
Format
"uuid"
channel
Type
string
Valid values
"all""counter""online"
Default
"all"
before

The next cursor of the previous page.

Type
string
limit
Type
integer
Default
50
Maximum
100

Responses​

OK

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

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress