Skip to content

Find a FundlyHub person beneficiary​

GET
/me/person-beneficiaries

Search active public profiles by name or handle, or use a complete exact email address. Partial emails return no results. Returns only public identity fields, never email/contact data. Private no-store response; authenticated rate limiter applies.

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​

Query Parameters

q*
Type
string
Required
Max Length
254

Responses​

Up to ten matching public identities

application/json
JSON
{
"data": [
{
"id": "string",
"name": "string",
"avatar": "string",
"profile_slug": "string"
}
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress