Skip to content

List beneficiary invitations for the signed-in recipient​

GET
/me/beneficiary-invitations

Returns at most 100 pending invitations matching this active account's verified primary or private contact email, excluding deleted campaigns and accounts pending deletion. Includes the shared public campaign-card projection (cover, organizer identity and fundraising state), and paid held gift net after fees, refunds and chargebacks; never includes the invited email. No-store response. Acceptance remains explicit, including for an already registered account.

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​

Pending invitations and their held amounts

application/json
JSON
{
"data": [
{
"id": "string",
"fundraiser_id": "string",
"name": "string",
"title": "string",
"slug": "string",
"currency": "string",
"held_cents": 0,
"campaign": {
"additionalProperties": "string"
}
}
]
}

Playground​

Server
Authorization

Samples​

Powered by VitePress OpenAPI

Built with VitePress