Skip to content

Get my Fundly's success story, any status​

GET
/fundraisers/{id}/success-story

The owner's view of their Fundly's success story: the whole row in any status, draft text included, and what they may do. Creates the draft row on first read when the Fundly is eligible and the pipeline has not made it yet. Owner only: anyone else gets 403 with code: NOT_OWNER, no session 401 UNAUTHORIZED, no story 404 NOT_FOUND. Every refusal on these three operations is { error, code }.

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​

Path Parameters

id*

The Fundly (fundraiser) id.

Type
string
Required
Format
"uuid"

Responses​

The story

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress