Profiles Overview

​

Overview

​

Base Endpoint

/api/profiles

​

Available Endpoints

​

Profile Object

interface Profile {
  id: string;
  email: string;
  full_name: string;
  role: "USER" | "ADMIN";
  is_active: boolean;
  birth_date?: string;
  is_profile_complete: boolean;
  created_at: string;
}

​

Profile Fields

​

Basic Information

• id: Unique identifier for the user
• email: User’s email address
• full_name: User’s full name
• role: User role (USER or ADMIN)

​

Status Fields

• is_active: Whether the user account is active
• is_profile_complete: Whether the user has completed their profile setup
• created_at: When the profile was created

​

Optional Fields

• birth_date: User’s date of birth (ISO 8601 date string)

​

User Roles

• USER - Standard user with basic permissions
• ADMIN - Administrator with elevated permissions

​

Authentication

​

Common Use Cases

• Display user information in dashboards
• Allow users to update their profiles
• Manage user accounts (admin)
• Verify user details before reservations
• Check if profile setup is complete

​

Permission Levels

​

Standard Users

• Can view their own profile
• Can update their own profile information

​

Administrators

• Can view all profiles
• Can update any profile
• Can manage user roles and status

​

Next Steps