Skip to main content
GET
/
users
/
me
Get current user
curl --request GET \
  --url https://api.stack-auth.com/api/v1/users/me
{
  "id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "primary_email_verified": true,
  "signed_up_at_millis": 1630000000000,
  "is_anonymous": true,
  "is_restricted": false,
  "restricted_by_admin": false,
  "selected_team": {
    "id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
    "display_name": "My Team",
    "profile_image_url": "https://example.com/image.jpg",
    "client_metadata": {
      "key": "value"
    },
    "client_read_only_metadata": {
      "key": "value"
    }
  },
  "primary_email": "johndoe@example.com",
  "display_name": "John Doe",
  "client_metadata": {
    "key": "value"
  },
  "client_read_only_metadata": {
    "key": "value"
  },
  "profile_image_url": "https://example.com/image.jpg",
  "selected_team_id": "team-id",
  "restricted_reason": null,
  "restricted_by_admin_reason": null
}

Documentation Index

Fetch the complete documentation index at: https://stackauth-e0affa27-apps-support.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Response

200 - application/json

Successful response

​
id
string
required

The unique identifier of the user

Example:

"3241a285-8329-4d69-8f3d-316e08cf140c"

​
primary_email_verified
boolean
required

Whether the primary email has been verified to belong to this user

Example:

true

​
signed_up_at_millis
number
required

The time the user signed up (identify) => (the number of milliseconds since epoch, January 1, 1970, UTC)

Example:

1630000000000

​
is_anonymous
boolean
required
​
is_restricted
boolean
required

Whether the user is in restricted state (has signed up but not completed onboarding requirements)

Example:

false

​
restricted_by_admin
boolean
required

Whether the user is restricted by an administrator. Can be set manually or by sign-up rules.

Example:

false

​
selected_team
object
​
primary_email
string

Primary email

Example:

"johndoe@example.com"

​
display_name
string

Human-readable user display name. This is not a unique identifier.

Example:

"John Doe"

​
client_metadata
object

Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.

Example:
{ "key": "value" }
​
client_read_only_metadata
object

Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.

Example:
{ "key": "value" }
​
profile_image_url
string

URL of the profile image for user. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.

Example:

"https://example.com/image.jpg"

​
selected_team_id
string

ID of the team currently selected by the user

Example:

"team-id"

​
restricted_reason
object

The reason why the user is restricted (e.g., type: "email_not_verified", "anonymous", or "restricted_by_administrator"), null if not restricted

Example:

null

​
restricted_by_admin_reason
string

Public reason shown to the user explaining why they are restricted. Optional.

Example:

null