GET /api/me — get current user profile + approval status

GET

/api/me

const url = 'https://example.com/api/me';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/me

Responses

200

Current user profile

application/json

The current user’s profile + session-bootstrap flags — the body of both GET /api/me and PUT /api/me. Faithful to the JSON [me_response] builds.

object

active_org_role

required

One of:

null
string

null

The acting user’s role in the active organization (#626), used by the web client to gate org-owned runner management (owner/admin manage; member views). null when the user has no active org membership yet.

string

Allowed values: owner admin billing_admin member

active_workspace_role

required

One of:

null
string

null

The acting user’s role in the active workspace, used by the web client to gate the tenant operability view. null when the user has no active workspace membership yet (a freshly provisioned account before its personal workspace resolves).

string

Allowed values: owner admin member viewer

approved

required

boolean

avatar_color

required

string | null

avatar_image_data

required

string | null

created_at

required

string format: date-time

default_verbosity

required

The user’s stored default live-feed verbosity (#583 / ADR 0049): the raw persisted label "reduced" | "chatty", or null when no default is set (the feed then falls back to the built-in reduced). The web CLI’s density command reads this to show / change the current setting.

string | null

display_name

required

string | null

email

required

The authenticated email; null for an identity without a stored email.

string | null

email_verified

required

boolean

required

string format: uuid

is_admin

required

boolean

locale

required

string

mfa_enabled

required

boolean

telegram_linked

required

boolean

Example

{
  "active_org_role": "owner",
  "active_workspace_role": "owner"
}

401

Authentication required

application/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object

code

required

Machine-readable, stable error code.

string

Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error

details

One of:

null
object

null

Present only on a quota-exceeded 403 — the inline upgrade-CTA payload.

object

key

required

The entitlement feature key that was hit, e.g. apps.max_count.

string

limit

required

The plan’s limit for this key.

integer format: int64

upgrade_url

required

Where to send the user to upgrade.

string

used

required

Current usage (count or bytes, per the key).

integer format: int64

error

required

Human-readable message (the server’s English text; the client may localize by code).

string

Example

{
  "code": "not_found"
}

500

Structured server error

application/json

object

code

required

Machine-readable, stable error code.

string

details

One of:

null
object

null

Present only on a quota-exceeded 403 — the inline upgrade-CTA payload.

object

key

required

The entitlement feature key that was hit, e.g. apps.max_count.

string

limit

required

The plan’s limit for this key.

integer format: int64

upgrade_url

required

Where to send the user to upgrade.

string

used

required

Current usage (count or bytes, per the key).

integer format: int64

error

required

Human-readable message (the server’s English text; the client may localize by code).

string

Example

{
  "code": "not_found"
}