VI | EN
Message us on Messenger
Developer resources

Get the TikTok Minis within an ad account — TikTok Business API

Get the TikTok Minis within an ad account · 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.

Get the TikTok Minis within an ad account

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

Use this endpoint to retrieve the list of TikTok Minis within an ad account.

To learn more about the campaign type where you can promote a TikTok Mini, see Create an Upgraded Smart+ TikTok Growth Max: Mini Games campaign and Create an Upgraded Smart+ TikTok Growth Max: Mini Dramas campaign.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/minis/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
pagequerynumberNoCurrent page number. Default value: 1. Value range: ≥ 1.
page_sizequerynumberNoPage size. Default value: 10. Value range: 1-50.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/minis/get/" \
  -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/minis/get/",
    params={},
    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/minis/get/');
for (const [k, v] of Object.entries({})) 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/minis/get/' . '?' . http_build_query([]);
$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 Codes.
messagestringResponse message. For details, see Appendix - Return Codes.
request_idstringThe log ID of a request, which uniquely identifies the request.
dataobjectReturned data.
listobject[]A list of TikTok Minis within an ad account.
minis_idstringThe ID of the TikTok Mini.
minis_namestringThe name of the TikTok Mini.
minis_icon_urlstringThe URL to the app icon image of the TikTok Mini.
minis_statusstringThe status of the TikTok Mini. Enum values: - `ACTIVE`: active. You can use the TikTok Mini to create ads. - `INACTIVE`: inactive. You cannot use the TikTok Mini to create ads.
minis_typestringThe type of the TikTok Mini. Enum values: - `MINI_SERIES`: mini drama. - `MINI_GAME`: mini game.
region_codesstring[]The region codes of the supported country or region for the TikTok Mini. Example: `["ID", "US"]`.
page_infoobjectPagination information.
pagenumberCurrent page number.
page_sizenumberPaging size.
total_numbernumberTotal number of results.
total_pagenumberTotal pages of results.

Response sample

{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "list": [
            {
                "minis_icon_url": "{{minis_icon_url}}",
                "minis_id": "{{minis_id}}",
                "minis_name": "{{minis_name}}",
                "minis_status": "ACTIVE",
                "minis_type": "MINI_GAME",
                "region_codes": [
                    "JP",
                    "US",
                    "ID"
                ]
            },
            {
                "minis_icon_url": "{{minis_icon_url}}",
                "minis_id": "{{minis_id}}",
                "minis_name": "{{minis_name}}",
                "minis_status": "ACTIVE",
                "minis_type": "MINI_GAME",
                "region_codes": [
                    "JP",
                    "US",
                    "ID"
                ]
            },
            {
                "minis_icon_url": "{{minis_icon_url}}",
                "minis_id": "{{minis_id}}",
                "minis_name": "{{minis_name}}",
                "minis_status": "ACTIVE",
                "minis_type": "MINI_SERIES",
                "region_codes": [
                    "JP"
                ]
            },
            {
                "minis_icon_url": "{{minis_icon_url}}",
                "minis_id": "{{minis_id_4}}",
                "minis_name": "{{minis_name_4}}",
                "minis_status": "ACTIVE",
                "minis_type": "MINI_SERIES",
                "region_codes": [
                    "US"
                ]
            }
        ],
        "page_info": {
            "page": 1,
            "page_size": 50,
            "total_number": 4,
            "total_page": 1
        }
    }
}

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