Skip to content

Look up an account by email before adding it as a member​

GET
/org-admin/{slug}/users/search

Confirms which FundlyHub account uses an email address, for the Members page's "Add member" form. q must be a complete email address; it is matched case-insensitively against account login emails only, and at most one result comes back, with the address masked. Anything that is not a complete email address (a name, a fragment, a phone number) answers 200 with an empty list. This is not a directory search.

Available only to organizations that are approved or verified; any other organization gets 403 with code: ORG_NOT_APPROVED.

Rate limited to 30 requests per minute per user, in one bucket shared with POST /org-admin/{slug}/members.

Note the bare { "results": [ … ] } envelope rather than data.

Requires permission: org.manage_members

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

slug*

The organization's slug (not its UUID).

Type
string
Required
Example"local-food-bank-a1b2c3"
Pattern
"^[a-z0-9][a-z0-9-]{0,254}$"

Query Parameters

q*

A complete email address (surrounding whitespace is trimmed). Matched case-insensitively against account login emails.

Type
string
Required
Example"sam@example.org"
Format
"email"
Max Length
254

Responses​

The matching account, or an empty list when no account uses that email or q is not a complete email address.

application/json
JSON
{
"results": [
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress