Skip to content

v0.5GitHub apistock.dev

API reference/Auth

Get the signed-in user

GET/v1/auth/me

bearer auth

Responses

200OKapplication/json

mfa_enabledbooleanrequired

Two-factor authentication is on

mfa_requiredbooleanrequired

A role of the account requires two-factor authentication

permissionsarray of stringrequired

Granted by the user's roles to this session

sessionobjectrequired

created_atstring (date-time)required

currentbooleanrequired

The session making this request

expires_atstring (date-time)required

When the session ends unless used again

idstringrequired

ipstring

last_seen_atstring (date-time)required

mfa_verifiedbooleanrequired

Signed in or confirmed with a second factor

user_agentstring

step_up_permissionsarray of stringrequired

Granted by the user's roles after signing in with a second factor

userobjectrequired

created_atstring (date-time)required

emailstringrequired

email_verifiedbooleanrequired

has_passwordbooleanrequired

The account has a password; accounts created with Google or Apple don't, until they reset one

idstringrequired

rolesarray of stringrequired

Platform roles, such as platform_admin

401Unauthorizedapplication/problem+json

codestringrequired

Stable machine-readable error code

detailstring

Human-readable explanation

errorsarray of object

Field-level validation errors

request_idstring

Correlates with server logs and traces

statusinteger (int64)required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

URI identifying the problem type

500Internal Server Errorapplication/problem+json

codestringrequired

Stable machine-readable error code

detailstring

Human-readable explanation

errorsarray of object

Field-level validation errors

request_idstring

Correlates with server logs and traces

statusinteger (int64)required

HTTP status code

titlestringrequired

Short summary of the problem type

typestring

URI identifying the problem type

Was this page useful?

v0.5

Request

curl -X GET "https://api.example.com/v1/auth/me" \
  -H "Authorization: Bearer $TOKEN"

req, _ := http.NewRequest("GET", "https://api.example.com/v1/auth/me", nil)
req.Header.Set("Authorization", "Bearer "+token)
resp, err := http.DefaultClient.Do(req)
if err != nil {
	return err
}
defer resp.Body.Close()

const res = await fetch("https://api.example.com/v1/auth/me", {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});
const data = await res.json();

Response

{
  "mfa_enabled": true,
  "mfa_required": true,
  "permissions": [
    "string"
  ],
  "session": {
    "created_at": "2026-09-15T12:00:00Z",
    "current": true,
    "expires_at": "2026-09-15T12:00:00Z",
    "id": "ses_nbswy3dpeb3w64tmmq",
    "ip": "string",
    "last_seen_at": "2026-09-15T12:00:00Z",
    "mfa_verified": true,
    "user_agent": "string"
  },
  "step_up_permissions": [
    "string"
  ],
  "user": {
    "created_at": "2026-09-15T12:00:00Z",
    "email": "ada@example.com",
    "email_verified": true,
    "has_password": true,
    "id": "usr_mfrggzdfmztwq2lk",
    "roles": [
      "string"
    ]
  }
}

{
  "code": "project_name_taken",
  "detail": "project name is already taken",
  "errors": [
    {
      "location": "body.name",
      "message": "expected length >= 1"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "status": 409,
  "title": "Conflict",
  "type": "string"
}

{
  "code": "project_name_taken",
  "detail": "project name is already taken",
  "errors": [
    {
      "location": "body.name",
      "message": "expected length >= 1"
    }
  ],
  "request_id": "req_9f86d081884c7d65",
  "status": 409,
  "title": "Conflict",
  "type": "string"
}

Base URL: https://api.example.com
Auth: bearer