Get Current User

Get current authenticated user profile with platform status, permissions, and companies

GET /api/auth/me

Get Current User

cURL

curl --request GET \
  --url https://api.example.com/api/auth/me \
  --header 'Authorization: <authorization>'

200

{
  "success": true,
  "data": {
    "id": "<string>",
    "email": "<string>",
    "fullName": "<string>",
    "phone": {},
    "avatar": {},
    "emailVerified": true,
    "lastLoginAt": {},
    "createdAt": "<string>",
    "isPlatformAdmin": true,
    "globalPermissions": [
      {
        "key": "<string>",
        "description": "<string>",
        "grantedAt": "<string>"
      }
    ],
    "companies": [
      {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "logo": {},
        "status": "<string>",
        "membershipId": "<string>",
        "membershipStatus": "<string>",
        "roles": [
          {
            "id": "<string>",
            "name": "<string>",
            "color": "<string>"
          }
        ],
        "permissions": [
          {}
        ]
      }
    ]
  }
}

Retrieves the complete profile of the currently authenticated user, including platform admin status, global permissions, and company memberships with their associated roles and permissions.

Authentication

Authorization · string · required

Bearer token with a valid access token.

Format: Bearer <access_token>

Response

success · boolean

Indicates if the request was successful.

data · object

Contains the user profile and related data.

Show data properties

id · string

Unique user identifier.

email · string

User’s email address.

fullName · string

User’s full name.

phone · string | null

User’s phone number.

avatar · string | null

URL to user’s avatar image.

emailVerified · boolean

Whether the email has been verified.

lastLoginAt · string | null

ISO 8601 timestamp of last login.

createdAt · string

ISO 8601 timestamp of account creation.

isPlatformAdmin · boolean

Whether the user has platform admin privileges.

globalPermissions · array

List of global permissions granted to the user.

Show globalPermissions items

key · string

Unique permission key.

description · string

Human-readable permission description.

grantedAt · string

ISO 8601 timestamp when permission was granted.

companies · array

List of companies the user is a member of.

Show companies items

id · string

Unique company identifier.

name · string

Company name.

slug · string

Company URL slug.

logo · string | null

URL to company logo.

status · string

Company status (e.g., ACTIVE, SUSPENDED).

membershipId · string

Unique membership identifier.

membershipStatus · string

Membership status (always ACTIVE in this response).

roles · array

List of roles assigned to the user in this company.

Show roles items

id · string

Role identifier.

name · string

Role name.

color · string

Hex color code for UI display.

permissions · array

List of unique permission keys aggregated from all roles in this company.

Error Responses

401 Unauthorized

Missing or invalid access token.

{
  "success": false,
  "error": {
    "message": "Unauthorized",
    "statusCode": 401
  }
}

404 Not Found

User not found in the database.

{
  "success": false,
  "error": {
    "message": "User not found",
    "statusCode": 404
  }
}

Example Request

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

Example Response

{
  "success": true,
  "data": {
    "id": "clx1234567890abcdef",
    "email": "[e-mail]",
    "fullName": "John Doe",
    "phone": "[phone]",
    "avatar": "https://example.com/avatars/user.jpg",
    "emailVerified": true,
    "lastLoginAt": "2026-03-04T10:30:00.000Z",
    "createdAt": "2026-01-15T08:20:00.000Z",
    "isPlatformAdmin": false,
    "globalPermissions": [
      {
        "key": "users:manage",
        "description": "Manage all platform users",
        "grantedAt": "2026-02-01T12:00:00.000Z"
      }
    ],
    "companies": [
      {
        "id": "clx9876543210zyxwvu",
        "name": "Acme Corporation",
        "slug": "acme-corp",
        "logo": "https://example.com/logos/acme.png",
        "status": "ACTIVE",
        "membershipId": "clx5555555555aaaaa",
        "membershipStatus": "ACTIVE",
        "roles": [
          {
            "id": "clx7777777777bbbbb",
            "name": "Admin",
            "color": "#FF5733"
          }
        ],
        "permissions": [
          "company:manage",
          "members:invite",
          "projects:create",
          "projects:delete"
        ]
      }
    ]
  }
}

Notes

• Only returns active memberships (status: ‘ACTIVE’)
• Permissions are deduplicated across all roles within each company
• Global permissions are separate from company-specific permissions
• Platform admin status is determined by the presence of a platformAdmin record