VI | EN
Message us on Messenger
Developer resources

(To be deprecated) Get details of videos in customized posts — TikTok Business API

(To be deprecated) Get details of videos in customized posts · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

(To be deprecated) Get details of videos in customized posts

GET/gmv_max/custom_anchor_video_list/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/
Description

Use this endpoint to retrieve the details of videos that have been used in the customized post collection for a Product GMV Max Campaign.

> Important

> This endpoint will be deprecated in the next API version. To ensure a seamless integration, retrieve the details of videos used in customized posts using /gmv_max/creation/custom_anchor_video_list/get/ and /gmv_max/creation/shop_video/video_anchors/.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer q360_live_ab12cd34_…Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand.
platform_shop_idquerystring7000000000000000001Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản.

Request parameters

NameInTypeRequiredSampleDescription
campaign_idquerystringYesThe ID of a GMV Max Campaign. To filter existing GMV Max Campaigns within your ad account, use /gmv_max/campaign/get/. Important: Starting April 30th, 2026, this parameter will be required to enhance security. To ensure a smooth API integration, we recommend that you update your integration to specify this parameter in all future calls.
campaign_custom_anchor_video_idquerystringYesThe ID of the collection of customized posts created in a Product GMV Max Campaign. To obtain the customized post collection associated with a Product GMV Max Campaign, use /campaign/gmv_max/info/ and check the returned campaign_custom_anchor_video_id.
custom_anchor_video_listqueryobject[]YesThe list of videos with customized product links (custom anchor videos) to filter the results by. Max size: 20. To obtain the customized posts associated with a Product GMV Max Campaign, use /campaign/gmv_max/info/ and check the returned custom_anchor_video_list.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/?campaign_id=&campaign_custom_anchor_video_id=&custom_anchor_video_list=%5B%7B%22item_id%22%3A%22%22%2C%22identity_info%22%3A%7B%22identity_id%22%3A%22%22%2C%22identity_type%22%3A%22%22%7D%7D%5D" \
  -H "Authorization: Bearer $KEY"
Python
import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/",
    params={
        "campaign_id": "",
        "campaign_custom_anchor_video_id": "",
        "custom_anchor_video_list": [
            {
                "item_id": "",
                "identity_info": {
                    "identity_id": "",
                    "identity_type": ""
                }
            }
        ]
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())
Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/');
for (const [k, v] of Object.entries({"campaign_id":"","campaign_custom_anchor_video_id":"","custom_anchor_video_list":[{"item_id":"","identity_info":{"identity_id":"","identity_type":""}}]})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());
PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/' . '?' . http_build_query(['campaign_id' => '', 'campaign_custom_anchor_video_id' => '', 'custom_anchor_video_list' => '[{"item_id":"","identity_info":{"identity_id":"","identity_type":""}}]']);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

NameTypeSampleDescription
codenumberResponse code. For the complete list of response codes and descriptions, see Appendix-Return Code.
messagestringResponse message. For details, see Appendix - Return Codes.
request_idstringThe log ID of a request, which uniquely identifies the request.
dataobjectReturned data.
custom_anchor_video_listobject[]The list of custom anchor videos.
item_idstringThe ID of the TikTok video. Example: `1234567891234567891`.
textstringThe caption of the TikTok post. Example: `summer`.
spu_id_liststring[]Returned only when `spu_id_list` is specified in the request. The list of Product SPU IDs that the TikTok post is associated with.
identity_infoobjectInformation about the identity associated with the TikTok post.
identity_idstringIdentity ID. Example: `identity_12345`.
identity_typestringIdentity type. Enum values: - `AUTH_CODE`: Authorized User. This type of identity is created when you use the authorization code to access a TikTok account or a TikTok post. - `TT_USER`: TikTok User. This type of identity is created when you bind your TikTok For Business account with your TikTok Business Account, or when you bind your TikTok For Business account with your regular TikTok account and then upgrade the account to Business Account. - `BC_AUTH_TT`: TikTok Account User in Business Center. This type of identity is created when you add a TikTok account to your Business Center, and the TikTok account owner approves your request. - `TTS_TT`: TikTok Account User for TikTok Shop. This type of identity is created when you set an official TikTok account for the TikTok Shop.
identity_authorized_bc_idstringReturned only when `identity_type` is `BC_AUTH_TT`. The ID of the Business Center that a TikTok Account User in Business Center identity is associated with.
identity_authorized_shop_idstringReturned for some `BC_AUTH_TT` identities. The ID of the TikTok Shop that the TikTok Account User in Business Center identity is associated with.
store_idstringReturned only when `identity_type` is `TTS_TT`. The ID of the TikTok Shop that a TikTok Account User for TikTok Shop identity is associated with.
profile_imagestringTemporary profile image URL for the TikTok account that is associated with the identity. Validity period: around 48 hours. The expiration time is included in the URL after the `x-expires` parameter, in the format of an Epoch/Unix timestamp in seconds. Once the URL expires, you need to call /gmv_max/custom_anchor_video_list/get/ to obtain a new URL.
user_namestringThe username of the TikTok account that is associated with the identity.
video_infoobjectDetails of the video in the post.
video_idstringThe ID of the video. Example: `video_12345`.
video_cover_urlstringTemporary URL for the video cover. Validity period: around 24 hours. The expiration time is included in the URL after the `x-expires` parameter, in the format of an Epoch/Unix timestamp in seconds. Once the URL expires, you need to call /gmv_max/custom_anchor_video_list/get/ to obtain a new URL.
preview_urlstringTemporary preview URL for the video. Validity period: six hours. Once the URL expires, you need to call /gmv_max/custom_anchor_video_list/get/ to obtain a new URL.
heightnumberThe height of the video in pixels. Example: 1920.
widthnumberThe width of the video in pixels. Example: 1080.
bit_ratenumberThe bit rate of the video in bps. Example: 8500323.
durationnumberThe duration of the video in seconds. Example: 3.669.
sizenumberThe size of the video in bytes. Example: 3898461.
signaturestringThe MD5 of the video. Example: `ab1cd2345e678fghi91jkl23b456m7no`.
formatstringThe format of the video. Example: `mp4`.
definitionstringThe definition of the video. Example: `1080p`.
fpsnumberThe frames per second (FPS) of the video. Example: 27.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "custom_anchor_video_list": [
            {
                "identity_info": {
                    "identity_id": "{{identity_id}}",
                    "identity_type": "TT_USER",
                    "profile_image": "{{profile_image}}",
                    "user_name": "{{user_name}}"
                },
                "item_id": "{{item_id}}",
                "spu_id_list": [
                    "{{spu_id}}"
                ],
                "text": "{{text}}",
                "video_info": {
                    "bit_rate": 824497,
                    "definition": "540p",
                    "duration": 10.444,
                    "format": "mp4",
                    "fps": 30,
                    "height": 960,
                    "preview_url": "{{preview_url}}",
                    "signature": "{{signature}}",
                    "size": 1076382,
                    "video_cover_url": "{{video_cover_url}}",
                    "video_id": "{{video_id}}",
                    "width": 540
                }
            }
        ]
    }
}

Get started

  1. Sign up for Partner
  2. Enable a data type of the Ads (Marketing API) group on the platform page
  3. Create an API key (tick the TikTok Business channel)
  4. Call it as in the examples above