Docs
Query Playlists
Request
HTTP URL | https://open.tiktokapis.com/v2/research/playlist/info/ |
HTTP Method | POST |
Scopes | research.data.basic (required) |
Headers
Key | Type | Description | Example | Required |
Authorization | string | The client access token obtained from /v2/oauth/token/. | Bearer clt.example12345Example12345Example | Yes |
Content-Type | string | The original media type of the resource | application/json | Yes |
Request Body
Key | Type | Description | Example Value | Required |
playlist_id | int64 | The unique ID of the playlist. | 1234569763387255595 | Yes |
cursor | int64 | Retrieve video results starting from the specified index | 15 | No |
Example
curl -L -X POST 'https://open.tiktokapis.com/v2/research/playlist/info/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer clt.xxxx
--data '{
"playlist_id": 1234534763387255595
}'Response
Body
Key | Type | Description |
data | PlayListInfoObject | The returned playlist info data |
error | ErrorStructV2 | Error object |
PlastListInfoObject
Key | Type | Description |
playlist_id | int64 | The unique ID of the playlist. |
playlist_item_total | int64 | Provides the total number of items in a playlist. |
playlist_last_updated | int64 | Provides info on when the playlist was last updated |
playlist_name | string | The name of the playlist. |
playlist_video_ids | list<i64> | Provides a list of all video IDs in a playlist. |
Example
{
"data": {
"playlist_id": 1234579763387255595,
"playlist_item_total": 4,
"playlist_last_updated": 1663620215,
"playlist_name": "Test playlist name",
"playlist_video_ids": [
1235181064686799659,
72895611234045119775,
727441234531538975,
12312311231231231,
123128834343521762606,
719192423452892379947,
7190923438988788615982,
7180065941324090155
]
},
"error": {
"code": "ok",
"message": "ok",
"log_id": "20240700200656033B747EC0C8DE33C94C"
}
}