Skip to content

List a sponsor's locations​

GET
/sponsors/{key}/locations

The open locations, home first. A storefront shows its street address and map point; a business that comes to customers shows the ZIP codes it serves and never its address (often a home); an online-only business shows its city. Each with its weekly hours, whether it is open now, closed now or temporarily closed (in its city's time zone), a closure within 30 days, whether its address is confirmed, and which perks work there. A location closed for good is not listed.

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

Query Parameters

near

lat,lng for each location's distance. Without it, a signed-in viewer's own place on their profile is used; never a guess from the IP address.

Type
string

Responses​

OK

application/json
JSON
{
"locations": [
],
"perksByLocation": {
"additionalProperties": [
]
},
"team": true
}

Playground​

Server
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress