v1

latestOpenAPI 3.0.02026-08-04891301.4 MB

Retrieve the current user

Returns the user associated with the authenticated session or bearer token. This is the canonical way to resolve "who am I?" after authentication.

The response includes the user's profile, notification settings, and profile picture, along with the app, organization, and sandbox the token is scoped to and their display names — enough to establish full session context in a single call. Unauthenticated requests return 401.

get/api/v1/users/me

Response

Successful response

aliasstring

Short handle or alias for the user. null if not set.

appstring

ID of the app this user (and their access token) is scoped to (dap_...). null if the user is not scoped to an app.

app_namestring

Display name of the user's app. null when the app association was not preloaded by the caller.

emailstring

Email address of the user.

idstring required

User ID (usr_...).

is_system_userboolean

true if this account is an internal system user rather than a human. System users are created automatically by the platform.

metadataobject

Arbitrary key-value metadata attached to the user. Defaults to an empty object.

namestring

Full display name of the user. null if the user has not set a name.

orgstring

ID of the organization this user belongs to (org_...). null if the user is not a member of any organization.

org_namestring

Display name of the user's organization. null when the user is not in an org, or when the org association was not preloaded by the caller.

org_rolestring

Role of the user within their organization. One of "admin", "member", or "viewer". null when the user is not a member of any organization.

sandboxstring

ID of the sandbox environment this user is scoped to (sbx_...). null for production users.

sandbox_namestring

Display name of the user's sandbox environment. null for production users, or when the sandbox association was not preloaded by the caller.

Example response

{
  "alias": "jdoe",
  "app": "dap_0aBcDeFgHiJkLmNoPqRsTu",
  "app_name": "Example Name",
  "email": "user@example.com",
  "id": "usr_0aBcDeFgHiJkLmNoPqRsTu",
  "is_system_user": true,
  "metadata": {
    "key": "value"
  },
  "name": "Example Name",
  "org": "org_0aBcDeFgHiJkLmNoPqRsTu",
  "org_name": "Example Name",
  "org_role": "member",
  "sandbox": "dsb_0aBcDeFgHiJkLmNoPqRsTu",
  "sandbox_name": "Example Name"
}