Skip to main content
TikTok for DevelopersTikTok for Developers

Docs

User Info

Overview

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

Authorization Scopes

  • user.info.basic gives read only access to a user's avatar and display name.

Documentation

Endpoint

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

Request

Request Body

Key

Type

Description

open_id

string

The TikTok user's unique identifier, which is obtained through `/oauth/access_token/`.

access_token

string

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

fields

set<string>

The set of user field lists as key in User Struct below. Default: ["open_id", "avatar"]. 


Choose to include from: ["open_id", "union_id", "avatar_url", "avatar_url_100", "avatar_url_200", "avatar_large_url", "display_name"]

Response

Response.data Struct

Key

Type

Description

data

map<string, User Struct>

The unique identification of the user in the current application.

Response.error Struct

Key

Type

Description

code

int32

Error code.

message

string

Error message describing the reason.

User Struct

Key

Type

Description

open_id

string

The unique identification of the user in the current application.

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.

avatar_url

string

User's profile image.

avatar_url_100

string

User's profile image in 100 * 100 size.

avatar_url_200

string

User's profile image in 200 * 200 size.

avatar_large_url

string

User's profile image with higher resolution.

display_name

string

User's profile name.

Code Example

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