Get current user profile

GET

/api/v1/me/profile

const url = 'http://localhost:3000/api/v1/me/profile';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url http://localhost:3000/api/v1/me/profile \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Responses

200

application/json

object

required

User ID

string

email

required

User email

string

name

User display name

string

phone

Phone number

string

timezone

required

Timezone

string

default: UTC

locale

required

Locale

string

default: en

emailNotifications

required

Email notifications enabled

boolean

default: true

smsNotifications

required

SMS notifications enabled

boolean

pushNotifications

required

Push notifications enabled

boolean

default: true

marketingEmails

required

Marketing emails enabled

boolean

bio

User bio

string

jobTitle

Job title

string

department

Department

string

location

Location

string

createdAt

required

Created at

string format: date-time

updatedAt

required

Updated at

string format: date-time

lastLoginAt

Last login timestamp

string format: date-time

isSuperAdmin

required

Whether the user is a super admin

boolean

roles

required

Effective roles for the current user

Array<string>

isEntraFederationEnabled

required

Whether the realm has Entra federation enabled (FM-1087). When true, manual role changes, invites, password resets, user creation and superadmin grant/revoke are governed by Entra mappings instead.

boolean

isFederated

required

Whether the CURRENT session user is federated (has a linked external identity provider, e.g. Entra). Derived from the users.identityProvider column (FM-1087). Used together with isEntraFederationEnabled to warn a non-federated user signed in on an Entra-enabled realm.

boolean

Example

{
  "timezone": "UTC",
  "locale": "en",
  "emailNotifications": true,
  "smsNotifications": false,
  "pushNotifications": true,
  "marketingEmails": false,
  "isSuperAdmin": false,
  "roles": [
    "admin"
  ],
  "isEntraFederationEnabled": false,
  "isFederated": false
}