Skip to content

Can the fund give to this Fundly?​

GET
/communities/{id}/fund/allocation-check

Owner only. Why not, when not: own_fundly (the owner organizes, co-organizes or is the beneficiary of the Fundly), dispute_open, negative_balance, fund_disabled, fundraiser_not_accepting, account_not_ready, debit_consent_required.

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 community's uuid or slug.

Type
string
Required

Query Parameters

fundraiser_id*
Type
string
Required
Format
"uuid"

Responses​

OK

application/json
JSON
{
"data": {
"eligible": true,
"reason": "string",
"available_cents": 0,
"to_leader_fundly": true,
"additionalProperties": "string"
},
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress