> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.littglobal.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.littglobal.com/_mcp/server.

# Get User Profile

POST TBD/api/v2/users/profile

This API is designed to provide a detailed overview of a user's profile information based on a provided username. It includes private user data, such as their email and phone number, as well as public data like their username, profile image, and settings preferences.

### Request Body

- `username` (string): The username of the user whose details you want to fetch.
    
- `user_id` (string): The unique identification number of the user whose details you want to fetch. This field is not necessary if a username is provided.
    

### Response

- `user_id` (string): The unique identification number of the user.
    
- `profile_version` (string): The version of user's profile.
    
- `image_id` (null/string): The unique id of the profile image.
    
- `user_image` (string): The URL of the user's profile image.
    
- `name` (string): The name of the user.
    
- `username` (string): The username of the user.
    
- `email` (string): The email of the user.
    
- `is_show_advt` (integer): A flag denoting whether to show advertisements to the user or not. If the value is 1, advertisements are shown; otherwise, they're not shown.
    
- `autoplay` (integer): A flag denoting whether to autoplay media for the user.
    
- `is_vip` (integer): A flag indicating if the user has a VIP status.
    
- `is_local_hero` (integer): A flag indicating if the user is labelled as a "local hero."
    
- `is_investor` (integer): A flag indicating if the user is an investor.
    
- `pending_vip` (integer): A flag indicating if the user has a VIP status pending.
    
- `bio` (string): The biography of the user.
    
- `privacy` (string): The privacy settings of the user. It can be either 'public' or 'private.'
    
- `mobile_country_code` (string): The mobile country code of the user.
    
- `mobile_number` (string): The mobile number of the user.
    
- `is_mobile_number_verified` (integer): A flag indicating if the user’s mobile number is verified.
    
- `dob` (string): The date of birth of the user.
    
- `age` (integer): The age of the user.
    
- `gender` (string): The gender of the user.
    
- `country_id` (integer): The id of the user's country.
    
- `user_agent` (string): The user agent string of the user's browser.
    
- `device_manufacturer` (null/string): The name of the device manufacturer.
    
- `device_model` (null/string): The device model.
    
- `device_os` (null/string): The device operating system.
    
- `device_os_version` (null/string): The device operating system version.
    
- `device_app_version` (null/string): The app version on the user's device.
    
- `merchant` (integer): A flag indicating if the user is a merchant.
    
- `linked_merchant_id` (null/string): The id for the linked merchant.
    
- `voice_bio` (null/string): The voice biography of the user.
    
- `background_image_id` (string): The id of the background image.
    
- `status` (integer): The user's status.
    
- `is_litt` (integer): A flag indicating if the user is marked as 'litt.'
    
- `joined_date` (string): The date the user joined.
    
- `country_selected` (integer): A flag indicating if the user has selected a country.
    
- `brags` (integer): The number of 'brags' the user has.
    
- `isFollowed` (integer), `isFollowingYou` (integer), `youFollowThem` (integer): Flags denoting follower relationship statuses.
    
- `pending` (integer), `declined` (integer), `blocked` (integer), `can_unblock` (integer): Flags denoting pending, declined, blocked, and can unblock statuses.
    
- `activeStory` (integer): A flag indicating if the user has an active story.
    
- `my_last_check_in` (null/string): The last check-in of the user.
    
- `check_ins` (array): Array of check-ins.
    
- `isOwner` (boolean): A flag indicating if the user is the owner.
    
- `is_preview_user` (integer): A flag indicating if the user is a preview user.
    
- `minimum_age` (null/string): The minimum age limit.
    
- `followers` (integer): The count of followers the user has.
    
- `following` (integer): The count of people the user follows.
    
- `likes` (integer): The count of likes the user has received.

Reference: https://docs.littglobal.com/litt-white-label/api-reference/user-profile/get-user-profile

## Request

### Query parameters

- `api_token` (string, optional)

## Response

### 200

Get User Profile

- `message` (string, optional)
- `api` (string, optional)
- `status` (string, optional)
- `data` (ApiV2UsersProfilePostResponsesContentApplicationJsonSchemaData, optional)

## Types

### ApiV2UsersProfilePostResponsesContentApplicationJsonSchemaData

- `user_id` (string, optional)
- `profile_version` (string, optional)
- `image_id` (any, optional, nullable)
- `user_image` (string, optional)
- `name` (string, optional)
- `username` (string, optional)
- `email` (string, optional)
- `is_show_advt` (integer, optional)
- `autoplay` (integer, optional)
- `is_vip` (integer, optional)
- `is_local_hero` (integer, optional)
- `is_investor` (integer, optional)
- `pending_vip` (integer, optional)
- `bio` (string, optional)
- `privacy` (string, optional)
- `mobile_country_code` (string, optional)
- `mobile_number` (string, optional)
- `is_mobile_number_verified` (integer, optional)
- `dob` (string, optional)
- `age` (integer, optional)
- `gender` (string, optional)
- `country_id` (integer, optional)
- `user_agent` (string, optional)
- `device_manufacturer` (any, optional, nullable)
- `device_model` (any, optional, nullable)
- `device_os` (any, optional, nullable)
- `device_os_version` (any, optional, nullable)
- `device_app_version` (any, optional, nullable)
- `merchant` (string, optional)
- `linked_merchant_id` (any, optional, nullable)
- `voice_bio` (any, optional, nullable)
- `background_image_id` (string, optional)
- `status` (integer, optional)
- `is_litt` (integer, optional)
- `joined_date` (string, optional)
- `country_selected` (string, optional)
- `brags` (integer, optional)
- `isFollowed` (integer, optional)
- `isFollowingYou` (integer, optional)
- `youFollowThem` (integer, optional)
- `pending` (integer, optional)
- `declined` (integer, optional)
- `blocked` (integer, optional)
- `can_unblock` (integer, optional)
- `activeStory` (integer, optional)
- `my_last_check_in` (any, optional, nullable)
- `check_ins` (ApiV2UsersProfilePostResponsesContentApplicationJsonSchemaDataCheckIns, optional)
- `isOwner` (boolean, optional)
- `is_preview_user` (integer, optional)
- `minimum_age` (any, optional, nullable)
- `followers` (integer, optional)
- `following` (integer, optional)
- `likes` (integer, optional)

### ApiV2UsersProfilePostResponsesContentApplicationJsonSchemaDataCheckIns

- `users` (list of any, optional)
- `others` (integer, optional)
- `total` (integer, optional)

## Examples

**Response**

```json
{
  "message": "User account has been loaded",
  "api": "user-profile",
  "status": "success",
  "data": {
    "user_id": "6c68dd44-a4b8-400b-b4f5-89c1802d5c28",
    "profile_version": "",
    "image_id": null,
    "user_image": "https://litt-ap-southeast-2-dev.s3-ap-southeast-2.amazonaws.com/1353513e-28db-4c21-b022-3126cc25c830/profile/placeholder_profile_image.png",
    "name": "Steven Yang",
    "username": "kokofoot",
    "email": "",
    "is_show_advt": 1,
    "autoplay": 1,
    "is_vip": 0,
    "is_local_hero": 0,
    "is_investor": 0,
    "pending_vip": 0,
    "bio": "",
    "privacy": "public",
    "mobile_country_code": "61",
    "mobile_number": "0400000000",
    "is_mobile_number_verified": 1,
    "dob": "",
    "age": 13,
    "gender": "prefer not to say",
    "country_id": 14,
    "user_agent": "PostmanRuntime/7.37.3",
    "device_manufacturer": null,
    "device_model": null,
    "device_os": null,
    "device_os_version": null,
    "device_app_version": null,
    "merchant": "0",
    "linked_merchant_id": null,
    "voice_bio": null,
    "background_image_id": "1",
    "status": 1,
    "is_litt": 0,
    "joined_date": "2024-03-12 09:13:03",
    "country_selected": "1",
    "brags": 0,
    "isFollowed": 0,
    "isFollowingYou": 0,
    "youFollowThem": 0,
    "pending": 0,
    "declined": 0,
    "blocked": 0,
    "can_unblock": 0,
    "activeStory": 0,
    "my_last_check_in": null,
    "check_ins": {
      "users": [],
      "others": 0,
      "total": 0
    },
    "isOwner": true,
    "is_preview_user": 0,
    "minimum_age": null,
    "followers": 0,
    "following": 2,
    "likes": 0
  }
}
```

**SDK Code**

```python User Profile_getUserProfile_example
import requests

url = "https://tbd/api/v2/users/profile"

querystring = {"api_token":"{{token}}"}

response = requests.post(url, params=querystring)

print(response.json())
```

```javascript User Profile_getUserProfile_example
const url = 'https://tbd/api/v2/users/profile?api_token=%7B%7Btoken%7D%7D';
const options = {method: 'POST'};

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

```go User Profile_getUserProfile_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tbd/api/v2/users/profile?api_token=%7B%7Btoken%7D%7D"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby User Profile_getUserProfile_example
require 'uri'
require 'net/http'

url = URI("https://tbd/api/v2/users/profile?api_token=%7B%7Btoken%7D%7D")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
```

```java User Profile_getUserProfile_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://tbd/api/v2/users/profile?api_token=%7B%7Btoken%7D%7D")
  .asString();
```

```php User Profile_getUserProfile_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://tbd/api/v2/users/profile?api_token=%7B%7Btoken%7D%7D');

echo $response->getBody();
```

```csharp User Profile_getUserProfile_example
using RestSharp;

var client = new RestClient("https://tbd/api/v2/users/profile?api_token=%7B%7Btoken%7D%7D");
var request = new RestRequest(Method.POST);
IRestResponse response = client.Execute(request);
```

```swift User Profile_getUserProfile_example
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://tbd/api/v2/users/profile?api_token=%7B%7Btoken%7D%7D")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```