Skip to main content
GET
Get current user

Authorizations

Authorization
string
header
required

Bearer authentication using a factapi-issued API key (ffy_<env>_<base32_uuid><base62_random>). Cookie-based sessions are accepted automatically by user-facing endpoints but are not surfaced as an OpenAPI auth scheme.

Response

OK

Profile of the authenticated user. Returned by GET /v1/me and PATCH /v1/me.

id
string
required

TypedID of the user.

Example:

"usr_01h2xcejqtf2nbrexx3vqjhp41"

email
string<email>
required

User's email address.

Example:

"alice@factify.com"

display_name
string
required

Display name shown in the UI. Always present.

Example:

"Alice Chen"

given_name
string | null

Given (first) name. Null when unknown.

Example:

"Alice"

family_name
string | null

Family (last) name. Null when unknown.

Example:

"Chen"