Skip to content

Full-text search​

GET
/search

Search across campaigns, organizations, users and donors. Queries shorter than two characters return an empty result set rather than an error. Authentication is optional and does not change the result set. Donor rows cover guest donors (matched on the name given at checkout — never on an email) and anonymous identities (matched on the localized alias the donor wall shows for that identity), and they link to /d/{kind}/{key}.
Two limits apply to donor rows specifically. They are returned on the FIRST PAGE ONLY (offset=0); the donor ranking is a single highest-given-first list with no stable second page, so a later offset would repeat the same rows rather than continue them. And a guest-donor name match needs three consecutive alphanumeric characters somewhere in the query — An, a_n and ___ match no guest donor. Anonymous alias matching is unaffected and keeps the two-character minimum. Campaigns, organizations and users page normally and have no such floor.

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

Parameters​

Query Parameters

q*

Search query. Fewer than 2 characters returns an empty result set.

Type
string
Required
scope

Limit to a specific resource type.

Type
string
Valid values
"all""campaigns""users""orgs""donors"
Default
"all"
limit
Type
integer
Default
20
Maximum
100
offset

Pages campaigns. Donor rows are returned only at offset=0 — see the description above.

Type
integer
Default
0
lang

Language an anonymous donor's alias is matched and cached in. Defaults from Accept-Language.

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

Responses​

Search results

application/json
JSON
"string"

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress