Skip to main content
TikTok for DevelopersTikTok for Developers

Docs

Get User Profile Information

Overview

The user/info/ endpoint returns some basic information of a given TikTok user.

HTTP URL

https://open-api.tiktok.com/user/info/

HTTP Method

POST

Scope

  • user.info.basic

Request

Headers

Key

Type

Description

Example

Required

Content-Type

string

"application/json"

"application/json"

Yes

Query Parameters

Key

Type

Description

Example

Required

access_token


string

The token that bears the authorization of the TikTok user, which is obtained through /oauth/access_token/.

act.1d1021d2aee3d41fee2d2add43456badMFZnrhFhfWotu3Ecuiuka27L56lr

Yes

Body

Key

Type

Description

Example

Required

fields


set<string>

Choose fields from: UserObject's fields


["open_id", "avatar_url"]

Yes

Example

curl -L -X POST 'https://open-api.tiktok.com/user/info/?access_token=act.1a4b9d05d9ad1a56294b93b5609cdfbdNzQgbpbUWyFNvhC9QqIvKEjuuPHn' \
-H 'Content-Type: application/json' \
--data-raw '{
    "fields": ["open_id", "union_id", "avatar_url"]
}'

Response

Key

Type

Description

data

map<string, UserObject>

Contains user object

error

object

Contains error code and error message

UserObject

Field

Type

Description

Scope

open_id


string

The unique identification of the user in the current application.Open id for the client

user.info.basic

union_id


string


The unique identification of the user across different apps for the same developer. For example, if a partner has X number of clients, it will get X number of open_id for the same TikTok user, but one persistent union_id for the particular user.

user.info.basic


avatar_url


string


A user's profile image.


user.info.basic


avatar_url_100


string

A user`s profile image in 100x100 size.

user.info.basic


avatar_large_url

string

A user's profile image with higher resolution.

user.info.basic


display_name


string

A user's profile name.

user.info.basic


bio_description


string

User's bio description if there is a valid one

user.info.basic


profile_deep_link

string

The link to user's TikTok profile page

user.info.basic

Example

{
    "data": {
        "user": {
            "avatar_url": "https://p-boei18n.bytedance.net/obj/aweme-upload-image/6919314666954933613",
            "open_id": "723f24d7-e717-40f8-a2b6-cb8463333b4",
            "union_id": "c9c60f44-a68e-4f5d-84dd-ce22fddb0ba1"
        }
    },
    "error": {
        "code": 0,
        "message": ""
    }
}