Skip to content

List sponsors​

GET
/sponsors

The sponsor directory: live or paused sponsors with a perk that is live, or ended less than 30 days ago. A city lists the sponsors with an open location whose address is in it, the same rule its "14 sponsors" counts by. Nearest first from near (a point the person chose to share; it only sorts), else from a signed-in viewer's own place, else by name. Each card leads with the perk the signed-in viewer can best use there, its state for them, and how many they can use; a guest sees neither. viewer.usable is the viewer's count over the whole city (the other filters aside). Without a city a signed-in viewer sees their own (cityDefault); city=all is every city.

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​

Query Parameters

city

A city page's slug, or all. Absent: a signed-in viewer's own city, else every city.

Type
string
category

Category ids, comma separated (coffee_cafe,bakery).

Type
string
q

Part of the name, a name it trades under, one of its places' names ("Midtown") or one of its perks.

Type
string
Max Length
80
near

lat,lng to sort from. Without it, a signed-in viewer's own place.

Type
string
Example"38.5762,-121.4805"
can_use

Signed in only - just the sponsors with a perk the viewer can use.

Type
string
Valid values
"true""1"
open_now

Just the sponsors with a storefront open now.

Type
string
Valid values
"true""1"
nearby

Just the sponsors with a storefront within 5 miles of the point (ignored without one).

Type
string
Valid values
"true""1"
new

Just the sponsors approved in the last 30 days.

Type
string
Valid values
"true""1"
online

Just the sponsors that sell online (online only

Type
string
Valid values
"true""1"
offers_help

Just the ones with help in Find help (#2423). Ignored while Resources are switched off.

Type
string
Valid values
"true""1"
limit
Type
integer
Default
24
Maximum
48
offset
Type
integer
Default
0

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress