Skip to content

Get what a gift would earn​

GET
/me/achievements/gift-outlook

What a gift from the caller to one Fundly would earn them in achievements: for each achievement the gift can move, where the caller stands and the breakpoint that moves it. The answer does not depend on the amount, so a checkout asks once per Fundly and compares the gift as the donor changes it. A Fundly that cannot earn the caller anything — their own, or one not taking gifts — answers 200 with eligible: false. Responses are private, no-store.

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)

Parameters​

Query Parameters

fundraiser_id*

The Fundly the gift is for.

Type
string
Required
Format
"uuid"
lang
Type
string

Responses​

The outlook

application/json
JSON
{
"data": "string",
"vocabulary": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress