Sign in

v15

latestOpenAPI 3.0.0MIT Licenseraw.githubusercontent.com2026-08-016088119.5 KB
user

Get user information

Retrieve the authenticated user's profile information including roles, metadata, and account status.

get/user

Response

User information

avatarUrlstring required

URL to the user's profile picture

createdAtstring date-time required

Timestamp when the user account was created

defaultRolestring required

Default authorization role for the user

displayNamestring required

User's display name

emailstring email

User's email address

emailVerifiedboolean required

Whether the user's email has been verified

idstring required

Unique identifier for the user

isAnonymousboolean required

Whether this is an anonymous user account

localestring required

User's preferred locale (language code)

metadataobject required

Custom metadata associated with the user

phoneNumberstring

User's phone number

phoneNumberVerifiedboolean required

Whether the user's phone number has been verified

rolesstring[] required

List of roles assigned to the user

activeMfaTypestring nullable

Active MFA type for the user

Example response

{
  "avatarUrl": "https://myapp.com/avatars/user123.jpg",
  "createdAt": "2023-01-15T12:34:56Z",
  "defaultRole": "user",
  "displayName": "John Smith",
  "email": "john.smith@nhost.io",
  "emailVerified": true,
  "id": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
  "locale": "en",
  "metadata": {
    "firstName": "John",
    "lastName": "Smith"
  },
  "phoneNumber": "+12025550123",
  "roles": [
    "user",
    "customer"
  ]
}