Skip to content

Get a sponsor's page​

GET
/sponsors/{key}

A sponsor's page for the person looking: the business, its numbers (from the same views the workspace and the admin portal read; givers thanked from 5 up), its perks with the viewer's eligibility, its open locations, the latest updates, the team members shown on the page (never cashiers), what FundlyHub checked (only checks that passed), and the viewer block (following, their role on the team, whether they may open the workspace). The team and staff also get teamWeek and each perk's counted uses. A live, paused, suspended or closed sponsor is public; any other is visible to its team and to staff only, and answers 404 to anyone else. An old slug answers with the current one in slug and renamed: true. A closed sponsor's page is a record: no perks.

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 (the browser's position, when the person allowed it). 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
"string"

Playground​

Server
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress