Skip to content

Get the businesses I invited to become sponsors​

GET
/me/referrals/businesses

The businesses the caller brought to FundlyHub, newest first: the ones that started Become a sponsor through the caller's link (/sponsors/join?ref=CODE, code below), and the ones the caller emailed an invite that haven't started yet (kind: invite, stage invited). A business that starts a page is listed by its page, matched by the email its creator signs in with. Each says how far it has got, in neutral words: invited (opened once it followed the email's link), started (setting up its page; step while a draft), submitted (with FundlyHub), live (live or paused; slug is its page) or not_live (never which, nor why: an ambassador never sees what a reviewer found). send (an invite) and reminder (a page being set up) say when the caller can email it again: three emails per address at most, three days apart. Perks used are counts from the sponsor's impact, shown for the businesses that went live; never who used them. Answers 403 while sponsors are switched off.

Requires permission: view_own_referral_portal.

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)

Responses​

The businesses

application/json
JSON
{
"code": "string",
"totals": {
"businesses": 0,
"live": 0,
"inProgress": 0,
"perksUsedAtLive": 0
},
"businesses": [
{
"kind": "string",
"id": "string",
"name": "string",
"categoryId": "string",
"logoUrl": "string",
"home": {
"label": "string",
"city": "string"
},
"locationKinds": [
"string"
],
"stage": "string",
"step": 0,
"slug": "string",
"email": "string",
"opened": true,
"startedAt": "string",
"sponsorSince": "string",
"perksUsed": 0,
"send": "string",
"reminder": {
"sentAt": "string",
"sendCount": 0,
"nextAt": "string",
"canSend": true
}
}
]
}

Playground​

Server
Authorization

Samples​

Powered by VitePress OpenAPI

Built with VitePress