Skip to content

Get user profile​

GET
/users/{id}

Public profile by UUID or profile_slug. Authentication is optional: the caller's own profile may include their email, and a profile marked private is redacted for every other viewer.
WHAT SURVIVES THE REDACTION (#1696): id, name, avatar, profile_slug, created_at and the four counters — campaign_count, total_funds_raised, follower_count and following_count — with their REAL values. The leaderboard has always published a private person's rank and impact, so a profile reporting zeroes beside a board reporting real figures would be two surfaces disagreeing about one person rather than privacy.
Dropped: bio, location, website, social_links, email, phone, private_contact_email, display_name, account_status, kyc_verified_at and account_kind. The last three are more than a name — a Team chip and a verification tick say something about the person, which is exactly what a private profile withholds.

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​

Path Parameters

id*

User UUID or profile_slug.

Type
string
Required

Responses​

User profile — a bare object, not wrapped in data. The fields marked own profile only are present only when the caller is the profile's owner.

application/json
JSON
{
"id": "string",
"name": "string",
"display_name": "string",
"email": "string",
"avatar": "string",
"bio": "string",
"location": "string",
"website": "string",
"social_links": {
"additionalProperties": "string"
},
"profile_visibility": "string",
"profile_slug": "string",
"account_status": "string",
"role": "string",
"campaign_count": 0,
"total_funds_raised": 0,
"follower_count": 0,
"following_count": 0,
"phone": "string",
"private_contact_email": "string",
"private_contact_verified": true,
"kyc_verified_at": "string",
"account_kind": "string",
"created_at": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress