Get User Profile

Retrieve the complete profile of the currently authenticated user, including account details, personal information, and active subscription status.

GET/api/v1/users/me

Get the authenticated user's full profile

Authentication:Bearer Token

Response Fields

The response contains three main sections:

Section	Description
`user`	Core account information including ID, role, and status
`profile`	Personal details such as name, phone, and address
`subscription`	Active subscription plan, expiry, and device limits

curl -X GET https://api.orbai.world/api/v1/users/me \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

200User profile retrieved successfully

{
  "success": true,
  "data": {
    "user": {
      "id": 12345,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "username": "johndoe",
      "email": "john@example.com",
      "role": "user",
      "active": true,
      "enabled": true,
      "auto_renew": true,
      "country": "US",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2026-02-01T14:22:00Z"
    },
    "profile": {
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+1-555-0100",
      "address": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "postal_code": "94102",
      "locale": "en-US",
      "language": "en",
      "birth_date": "1990-05-15",
      "telegram_chat_id": "987654321",
      "telegram_username": "johndoe_tg"
    },
    "subscription": {
      "plan_name": "Premium",
      "status": "active",
      "expires_at": "2026-06-15T00:00:00Z",
      "max_devices": 10,
      "days_remaining": 127
    }
  }
}

401Authentication required or token expired

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or expired access token"
  }
}

Update User Profile

Update the authenticated user's profile information. All fields are optional; only the fields you include in the request body will be updated.

PUT/api/v1/users/me

Update the authenticated user's profile

Authentication:Bearer Token

Parameter	Type	Required	Description
`country`	string	Optional	Two-letter ISO country code (e.g., US, DE, JP)
`fcm_token`	string	Optional	Firebase Cloud Messaging token for push notifications
`auto_renew`	boolean	Optional	Enable or disable automatic subscription renewal
`wallet_address`	string	Optional	Blockchain wallet address for token rewards
`first_name`	string	Optional	User's first name
`last_name`	string	Optional	User's last name
`display_name`	string	Optional	Public display name shown in the app
`phone`	string	Optional	Phone number in international format
`address`	string	Optional	Street address
`city`	string	Optional	City name
`state`	string	Optional	State or province
`postal_code`	string	Optional	ZIP or postal code
`locale`	string	Optional	Locale code for regional formatting (e.g., en-US, de-DE)
`telegram_username`	string	Optional	Telegram username for notifications integration
`birth_date`	string	Optional	Date of birth in YYYY-MM-DD format

curl -X PUT https://api.orbai.world/api/v1/users/me \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "auto_renew": true,
    "telegram_username": "johndoe_tg"
  }'

200Profile updated successfully

{
  "success": true,
  "data": {
    "user": {
      "id": 12345,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "username": "johndoe",
      "email": "john@example.com",
      "role": "user",
      "active": true,
      "enabled": true,
      "auto_renew": true,
      "country": "US",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2026-02-08T09:15:00Z"
    },
    "profile": {
      "first_name": "John",
      "last_name": "Doe",
      "phone": "+1-555-0100",
      "address": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "country": "US",
      "postal_code": "94102",
      "locale": "en-US",
      "language": "en",
      "birth_date": "1990-05-15",
      "telegram_chat_id": "987654321",
      "telegram_username": "johndoe_tg"
    }
  }
}

400Invalid request parameters

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid country code. Must be a valid ISO 3166-1 alpha-2 code."
  }
}

Partial Updates

You do not need to send all fields when updating your profile. Only include the fields you want to change. Omitted fields will retain their current values.

User Profile

Get User Profile

Response Fields

Update User Profile

Partial Updates

On this page