Communities
Communities (#2065): the directory, the community page and its tabs, joining, people, invites, roles, posts, sharing Fundlies, and each person's community settings.
List communities (the directory)
Active, listed communities. q (2 characters or more) matches name, city and about; category is a kind or paid. counts apply q and ignore category.
Parameters
Query Parameters
"all""paid""city""church""diaspora""families""school""workplace""other""all""featured""members""raised""new""featured"1482400Responses
OK
Create a community
The caller becomes the owner. Co-leaders get invites with their role. draft: true keeps it visible to the owner only. Settings are audit-logged; community.created is published.
Authorizations
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.
Request Body
Responses
OK
Top communities this month
The current calendar month, ranked by money raised for their Fundlies, new members, or Fundlies fully funded.
Parameters
Query Parameters
"raised""new_members""funded""raised"1205Responses
OK
Check a community link
Whether /communities/<slug> is free, and a suggestion when it is not.
Authorizations
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.
Parameters
Query Parameters
Responses
OK
Who would hear about a shared Fundly
For the share step: distinct people across up to 3 of the caller's communities (minus the caller), the overlap who hear once, and per community the instant and digest counts. Counts only.
Authorizations
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.
Parameters
Query Parameters
Comma-separated community ids or slugs, at most 3.
Responses
OK
Featured communities for the home page
Preview an invite
Works for a member's share link code and for an emailed invite token. Shows the community and who invited.
Parameters
Path Parameters
An invite link code or an emailed invite token.
Responses
OK
Accept an invite
A share link joins (or requests, when approval applies); an emailed invite joins with its role. A paid community answers 402 for a member invite.
Authorizations
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.
Parameters
Path Parameters
An invite link code or an emailed invite token.
Responses
OK
Decline an invite
Declines an emailed invite.
Authorizations
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.
Parameters
Path Parameters
An invite link code or an emailed invite token.
Responses
OK
Get a community
404 for a draft (except to its owner), a deleted community, or a hidden or suspended one (except to its members). A private community answers 200; its feed and members are gated.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Delete a community
Owner only. A soft delete; 409 HAS_MONEY while the fund holds money or memberships are paying.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Update a community
Owner and leaders. Plan fields (membership, prices, perks, leaders_join_free) are owner only and follow the paid-membership rules. publish: true turns a draft live. Attribute CRUD: audit-logged, no event.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Request Body
Responses
OK
A community's About tab
Public, private communities included.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
A community's feed
Posts, the projection of community events (Fundlies posted, milestones, joins grouped per week, fund moves when the viewer can see the fund) and updates on Fundlies posted here, newest first. 403 MEMBERS_ONLY for non-members of a private community.
Parameters
Path Parameters
The community's slug or uuid.
Query Parameters
15020next_before from the previous page.
Responses
OK
Fundlies posted in a community
Public, private communities included. Active = live and not fully funded; funded = raised at least the goal; ended = neither. q matches title, organizer name and city.
Parameters
Path Parameters
The community's slug or uuid.
Query Parameters
"active""funded""ended""active""newest""most_raised""ending""newest"1482400Responses
OK
A community's members
The team first (owner, leaders, volunteers), then members, newest first; with show_leaders off and a viewer below leader, one list without roles. q matches public names; total is the match count.
Parameters
Path Parameters
The community's slug or uuid.
Query Parameters
"all""team""leaders""volunteers""members""new_month"11004800Responses
OK
Add people
Adds where the person's setting allows it, otherwise sends an invite. Up to 50 adds and invites a day per person. Added people get one notification with a Leave action.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Request Body
Responses
OK
Who hears a new Fundly
Owner, leaders and volunteers. Counts only; members' own settings stay private.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Join a community
One tap for a public community without approval; a request otherwise. A share link without approval (made by an owner or leader) joins directly. 402 PAYMENT_REQUIRED for a paid community; 403 REMOVED for a removed person.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Request Body
Responses
OK
Leave a community
409 OWNER_MUST_TRANSFER for the owner; 409 PAID_MEMBERSHIP_ACTIVE while a paid membership runs (cancel it first).
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Join requests
Owner, leaders and volunteers.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Approve a join request
Owner, leaders and volunteers. Publishes community.member_joined.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Responses
OK
Deny a join request
Owner, leaders and volunteers.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Responses
OK
Deny a join request (alias)
The same as /deny.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Responses
OK
My membership settings
The caller's role and alert choice in this community.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Change my alerts here
Alert level, channels (an array or a partial object), mute (mute_days or muted_until, null unmutes) and pin to home.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Request Body
Responses
OK
Add people: search and suggestions
Names and handles of public profiles, or an exact email; with no q, people the caller knows. state says whether an Add adds them right away (their community_add_policy) or sends an invite.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Query Parameters
Responses
OK
Remove a member
Owner and leaders; never the owner; a leader cannot remove a leader. A removed person rejoins only through a leader's invite.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Responses
OK
Change a member's role
Leaders change roles below leader; only the owner makes or unmakes leaders. 409 LEADER_LIMIT past 10 leaders, the owner included.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Request Body
Responses
OK
Hand the community to a leader
Owner only; the new owner must be an active leader. The old owner becomes a leader, or leaves with leave: true.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Request Body
Responses
OK
Pending invites
Owner, leaders and volunteers. An address shows only for invites typed as an address.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Invite people
By email or account. Invites expire after 14 days. A volunteer role needs a leader; a leader role needs the owner.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Request Body
Responses
OK
Resend an invite
A fresh token and 14 more days; once a day.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Responses
OK
Cancel an invite
Owner, leaders and volunteers, or whoever sent it.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Responses
OK
My invite link
Each member has their own link (/communities/<slug>?invite=<token>), so joins credit them.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Change my invite link
Owner and leaders: approval for each join, and an expiry.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Request Body
Responses
OK
Replace my invite link
A new token; the old one stops working.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Post to a community
Owner, leaders and volunteers; pinning needs owner or leader, and unpins the previous post.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Request Body
Responses
OK
Delete a post
The author, or owner and leaders.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Responses
OK
Edit or pin a post
The author edits; owner and leaders pin.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Request Body
Responses
OK
Communities I can share a Fundly to
The caller's active communities, with this Fundly's share state when fundraiser_id is given (it may not exist yet).
Authorizations
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.
Parameters
Query Parameters
"uuid"Responses
OK
A Fundly's community shares
The organizer's view of where the Fundly is shared and what each share waits for.
Authorizations
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.
Parameters
Path Parameters
The fundraiser id.
"uuid"Responses
OK
Share a Fundly to communities
At most 3, exactly one primary; [] removes every share. A share posts only after the Fundly passes verification and, under leader approval, a leader approves; community.fundly_posted fires then.
Authorizations
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.
Parameters
Path Parameters
The fundraiser id.
"uuid"Request Body
Responses
OK
Fundlies waiting for approval
Owner and leaders: shares waiting under leader approval.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Approve a shared Fundly
Owner and leaders. Posts it now if it passed verification.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Responses
OK
Reject a shared Fundly
Owner and leaders.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
"uuid"Responses
OK
My communities
Pinned first, then by role and name, with my alert choice and any paid membership.
Authorizations
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.
Responses
OK
My community settings
Who can add me, quiet hours, profile and leaderboard visibility, timezone.
Authorizations
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.
Responses
OK
Change my community settings (PUT)
The same as PATCH.
Authorizations
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.
Request Body
Responses
OK
Change my community settings
Partial. Quiet hours are 10pm to 7am local; only enabled is stored.
Authorizations
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.
Request Body
Responses
OK
A person's communities
One-click unsubscribe (RFC 8058)
The List-Unsubscribe-Post target mailbox providers call. The signed token names one address and one scope (the email's category); that one suppression is written at once.
Parameters
Query Parameters
The signed unsubscribe token from the List-Unsubscribe header.
Responses
OK
Connect the community's Stripe account
Owner only. Creates (or reuses) the community's own Stripe Express account, which the owner verifies, and returns a fresh Stripe-hosted onboarding link that returns to the community's settings. accept_debit_terms: true records the owner's consent to Stripe Account Debits, which giving from the fund to a Fundly needs. Requires a signed-in session.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Request Body
Responses
OK
The community's Stripe account status
Owner and leaders. Read live from Stripe (the stored row when Stripe is unreachable).
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Responses
OK
Open the community's Stripe dashboard
Owner only: a one-time Stripe Express dashboard login link (bank account, payouts).
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Responses
OK
The paid membership plan
Public. The monthly and yearly price, perks, who receives the dues (named even when leaders are hidden), a price change serving its 30 days of notice, the card fee preview (FundlyHub keeps 0%), and that dues are not tax-deductible.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Responses
OK
Change the paid membership plan
Owner only. A price change with paying members is scheduled: every paying member is emailed and moves to the new price at their first renewal 30 days or more after the notice; new joiners pay it at once. Paid to free cancels every subscription at period end. Audit-logged, no event.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Request Body
Responses
OK
My membership settings
The caller's role and alert choice in this community.
Authorizations
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.
Parameters
Path Parameters
The community's slug or uuid.
Responses
OK
Join a paid community
With approval (leaders approve, or a private community): creates the join request and returns a SetupIntent client_secret (intent_type: setup) to save the card. Nothing is charged until a leader approves; then the subscription is created and the saved card charged. Without approval: returns the first invoice's PaymentIntent secret (intent_type: payment); the member is in once it is paid. Dues go to the community's own Stripe account; FundlyHub keeps 0%. Dues are not donations and are not tax-deductible.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Request Body
Responses
OK
Cancel a paid membership (leave)
Cancels at the end of the paid period: access lasts until access_until, no further charge, then the member leaves. A membership never charged (waiting for approval) ends at once.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Responses
OK
Undo a cancellation
Before the period ends, keeps the membership renewing.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Responses
OK
My paid community memberships
Every live paid membership of the signed-in person, for Settings: price, renewal, card. Dues are not tax-deductible.
Authorizations
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.
Responses
OK
Receipts for a paid membership
The membership's paid and open Stripe invoices with their hosted and PDF links.
Authorizations
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.
Parameters
Path Parameters
"uuid"Responses
OK
The community fund
Visibility applies: public anyone; members paying members, the owner and leaders; private the owner and leaders. A viewer who cannot see the fund gets 200 with viewer and the settings only. Dues are one row a month; an anonymous giver is named to leaders only. payout_account is for the owner and leaders, hold for the owner.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Query Parameters
110020Responses
OK
Fund settings
Owner only. On: the account pays out manually and the money collects; off: weekly payouts. Visibility changes are audit-logged (no event) and hide past activity too. accept_debit_terms: true records the Account Debit consent.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Request Body
Responses
OK
The fund activity, paged
Same visibility as the fund.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Query Parameters
11002000Responses
OK
Export the fund activity (CSV)
Owner and leaders. Every entry, givers named, dues by month.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Responses
CSV
Give once to the community fund
Anyone, guests included (a guest gives donor_email). A destination charge to the community's own Stripe account: the card fee comes out, FundlyHub keeps 0%. A gift to the fund is not a donation to a Fundly and is not tax-deductible. Confirm the returned PaymentIntent with Stripe Elements. Needs the same reCAPTCHA token as a donation's payment intent (recaptcha_token or x-recaptcha-token; signed-in verified users are exempt).
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Request Body
Responses
OK
Can the fund give to this Fundly?
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
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.
Parameters
Path Parameters
The community's uuid or slug.
Query Parameters
"uuid"Responses
OK
Give from the fund to a Fundly
Owner only, signed-in session. A Stripe Account Debit moves the money from the community account to the platform, then a donation from "Idempotency-Key header (or idempotency_key): the same key returns the first result; with a different body, 409 IDEMPOTENCY_CONFLICT. Publishes community.fund_allocated after commit.
Authorizations
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.
Parameters
Header Parameters
200Path Parameters
The community's uuid or slug.
Request Body
Responses
OK
Send the withdrawal code
Owner only, signed-in session. Emails a 6-digit one-time code (10 minutes, one use, 5 attempts) to the owner's account address; at most 5 an hour.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Responses
OK
Withdraw from the fund to the community bank
Owner only, signed-in session. A payout from the community's Stripe account to its bank, with a reason (at most 120 characters) and the emailed code. Blocked while a dispute is open or the balance is negative. Audit-logged; publishes community.fund_withdrawn after commit.
Authorizations
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.
Parameters
Path Parameters
The community's uuid or slug.
Request Body
Responses
OK
Funds I can give from to this Fundly
The donation widget's "Pay with" list: community funds the signed-in person owns, with money in them, that may give to this Fundly (never the person's own, co-organized or beneficiary Fundly). A fund with an open dispute or a negative balance is listed with the reason.
Authorizations
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.
Parameters
Query Parameters
"uuid"Responses
OK