v1

latestOpenAPI 3.1.1Apache 2.02026-07-26774088.4 KB
Me

My user profile

Returns the current user's profile data.

Response attributes

The response will include the following attributes:

  • initials - A derived attribute that represents the user's initials based on their name. This is typically used for avatar placeholders or compact user displays. For example, "John Doe" would have initials "JD".
  • name - The user's full name. This is a required field that can be:
    • Set directly as a full name
    • Automatically generated from first name and last name fields when either changes
    • Used for display purposes throughout the platform
  • email - The user's email address. This is a critical field that:
    • Is required and must be unique
    • Is used for authentication
    • Can trigger email change notifications
    • Is used for password recovery
    • Can be marked as bounced (and reset when email changes)
    • Is validated against email format requirements
  • role_level - Represents the user's permission level in the system. This attribute:
    • Common values include:
      • OWNER - Account owner with full permissions
      • ADMINISTRATOR - Admin with site management permissions
      • Determines what actions and resources the user can access
      • Is used for permission checks throughout the system
get/v1/me

Response

Success