Skip to content

Resources​

Find help: free and low-cost local help from non-profits, churches, businesses, communities and public programs. The search (a POST, so a sensitive topic never lands in a URL or a log), the topics with their hotlines and first steps, a provider's page, the "Help we offer" section other pages show, reporting a problem with a listing, and suggesting a place that helps. No account is needed. A confidential address never appears in any answer: only its city and that the address is given by phone. A private community's members-only help is shown only to its active members, and never in the search. Every operation answers 403 while Resources are switched off. Refusals come as { "error": { "code", "message", "details" } }, where code is the reason to branch on.


Find help​

POST
/resources/search

Provider cards with their matching help, facets and the total. A city matches help whose service area is the city, one of its ZIP codes, its state or the whole country, or that has a location in it; a ZIP code or a point resolves to its city first. Order: open now first when openNow is asked for, then nearest (to the provider's nearest public storefront; online and confidential help have no distance), then the most recently confirmed. Nothing is paid or boosted. Help whose capacity is paused, and a private community's members-only help, are never listed. A search that finds nothing is counted by city and topic only. It is a POST so a sensitive topic never lands in a URL; the answer is sent Cache-Control: no-store.

Authorizations​

or
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)

Request Body​

application/json
JSON
"string"

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Body

Samples​


List topics, needs and hotlines​

GET
/resources/topics

"What's going on?": every active topic with its one sentence, reviewed first steps (at most 3), hotlines and needs, plus the hotlines and the urgent strip, in the reader's language (lang, then the language cookie, then Accept-Language; English otherwise). Cached for 60 seconds.

Authorizations​

or
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

lang
Type
string
Valid values
"en""ru""uk""es"

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​


Read a provider's page​

GET
/resources/providers/{slug}

The provider's card, every resource the viewer may see (a private community's members-only help only for its active members), the places they happen (a street and a pin only for a public storefront no confidential help shares) and its verified licenses (holder, kind, state and the date checked). A provider with nothing public now answers not_listed with similar providers, never a 404. An old slug answers 301 to the current page. Cached for 60 seconds for a guest; never for a signed-in person.

Authorizations​

or
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

slug*
Type
string
Required

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​


Read the help an organization, business or community offers​

GET
/resources/for/{kind}/{entitySlug}

Up to limit resources for a page's "Help we offer" section, help for everyone first, with the total and the provider page's slug for See all. The same visibility as the provider page. An entity with no help the viewer may see answers an empty list.

Authorizations​

or
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

kind*
Type
string
Required
Valid values
"nonprofit""church""sponsor""business""community"
entitySlug*

The non-profit's, business's or community's own slug.

Type
string
Required

Query Parameters

limit
Type
integer
Default
3
Maximum
12

Responses​

OK

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value

Samples​


Report a problem with a listing​

POST
/resources/{id}/reports

Wrong info, closed, unsafe, scam or other; signed out is allowed. One report per reporter, resource and day: a second answers 200 with the first (duplicate: true). At most 10 reports a day per reporter. Who reported is kept as a keyed hash, never the IP address. Unsafe and scam reports reach FundlyHub's on-call staff at once. Nothing is taken down automatically, and the reporter is never told the outcome.

Authorizations​

or
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*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"reason": "string",
"note": "string",
"email": "string"
}

Responses​

The same report, made earlier today.

application/json
JSON
"string"

Playground​

Server
Variables
Key
Value
Body

Samples​


Suggest a place that helps​

POST
/resources/suggestions

A name, a city and an optional website, US phone number, topics and note, for FundlyHub's staff to look into. Signed out is allowed, at most 5 a day per suggester.

Authorizations​

or
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)

Request Body​

application/json
JSON
{
"name": "string",
"city": "string",
"website": "string",
"phone": "string",
"topics": [
"string"
],
"note": "string"
}

Responses​

Received.

application/json
JSON
{
"id": "string"
}

Playground​

Server
Body

Samples​


List my saved providers​

GET
/me/resource-saves

The providers the signed-in person saved, newest first (at most 200). Each comes with its card while it still has help the person may see; otherwise listed is false ("No longer listed") and there is no card. Only that person ever sees their saves: never cached, never shared, never in an event or an audit log.

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​

OK

application/json
JSON
"string"

Playground​

Server
Authorization

Samples​


Save a provider​

PUT
/me/resource-saves/{providerId}

Saves a provider for My help. Saving again changes nothing and answers the first save. Only a provider with help the person may see now can be saved (a private community's members-only help for its members); anything else is a 404.

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

providerId*
Type
string
Required
Format
"uuid"

Responses​

Saved.

application/json
JSON
{
"providerId": "string",
"saved": true,
"savedAt": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Unsave a provider​

DELETE
/me/resource-saves/{providerId}

Removes the save. A provider that isn't saved is not an error.

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

providerId*
Type
string
Required
Format
"uuid"

Responses​

Not saved now.

Playground​

Server
Authorization
Variables
Key
Value

Samples​


Powered by VitePress OpenAPI

Built with VitePress