Get the Page ID
GET/page/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/page/get/
Description
Use this endpoint to get the Page ID. After a page is created, you can get the page ID and then use the page ID in your ads.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/page/get/
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| Authorization | header | header | Bearer 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_id | query | string | 7000000000000000001 | Tà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
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| library_id | query | string | No | Either advertiser_id or library_id has to be set.
To get pages under a Business Center, you must specify the ID of the form library that contains the page and leads. You can migrate pages and leads from an ad account to a Business Center. | |
| page | query | number | No | Current number of pages. Default value: 1. Value range: ≥ 1. | |
| page_size | query | number | No | Page size. Default value: 10. Value range: 1-100. | |
| status | query | string | No | Page status.
Enum values: EDITED (draft), PUBLISHED (ready). | |
| title | query | string | No | The page name for filtering results. This filter supports exact matches. | |
| update_time_range | query | object | No | Filter for pages updated in the specified time range. | |
| business_type | query | string | No | Page type.
Enum values: LEAD_GEN(Instant Form), STORE_FRONT(Storefront Page), APP_PROFILE_PAGE (App Profile Page),TIKTOK_INSTANT_PAGE (Custom Page or Custom TikTok Instant Page), SHOP_ADS_PLP (Shop Ads Product List Page), SHOP_ADS_PDP (Shop Ads Product Detail Page), POP_UP_FORM(Direct Message Page).
Default value: LEAD_GEN. | |
| business_types | query | string[] | No | Page types.
Enum values: LEAD_GEN(Instant Form), STORE_FRONT(Storefront Page), APP_PROFILE_PAGE (App Profile Page),TIKTOK_INSTANT_PAGE (Custom Page or Custom TikTok Instant Page), SHOP_ADS_PLP (Shop Ads Product List Page), SHOP_ADS_PDP (Shop Ads Product Detail Page), POP_UP_FORM(Direct Message Page).
Note: If it is passed concurrently with business_type, the value of business_type will be ignored. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/page/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/page/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/page/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/page/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)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | number | Return code, see Appendix-Return codes. | |
| message | string | Return Message, see Appendix-Return codes. | |
| data | object | Return data. | |
| list | object[] | Page list. | |
| page_id | string | Page ID. | |
| status | string | Page status. Enum values: `EDITED` (draft), `PUBLISHED` (ready). | |
| title | string | Title. | |
| preview_url | string | Preview link of the page. The link is generated after the page is ready, and will be empty when the page is only a draft. | |
| template_id | string | The ID for the page's template. It indicates the specific template type associated with this page. | |
| template_name | string | The name of the template type that the page uses. | |
| supported_objectives | string[] | Returned only when the following conditions are both met: - The page is associated with a `template_id`. - The corresponding template is compatible with certain objectives.A list of campaign objectives compatible with this page template. Enum values: `APP_PROMOTION`, `WEB_CONVERSIONS`, `LEAD_GENERATION`, `TRAFFIC`, `REACH`, `VIDEO_VIEWS`, `ENGAGEMENT`, `PRODUCT_SALES`, `RF_REACH`. For a detailed explanation of enum values, see Enumeration-Advertising Objective. Note: - Even with a supported objective, you can only use the page if it is compatible with all other campaign settings. | |
| thumbnail | string | Page preview thumbnail image. | |
| create_time | string | The creation time of the page in the format of `YYYY-MM-DD HH:MM:SS` (UTC time). Example: `2024-01-01 00:00:00`. | |
| update_time | string | The time the page was last updated in the format of `YYYY-MM-DD HH:MM:SS` (UTC time). Example: `2024-01-01 00:00:00`. | |
| publish_time | string | The publishing time of the page in the format of `YYYY-MM-DD HH:MM:SS` (UTC time). Example: `2024-01-01 00:00:00`. | |
| app_id | string | Returned for all App Profile Pages and TikTok Instant Pages where an App is specified. The ID of the App that is specified in the page. To filter App Profile Pages, set `business_type` to `APP_PROFILE_PAGE` or set `business_types` to `["APP_PROFILE_PAGE"]` in the request. | |
| has_cpp | boolean | Returned only for TikTok Instant Pages. Whether the TikTok Instant Page contains Custom Product Page. Enum values: `true`, `false`. To filter TikTok Instant Pages, set `business_type` to `TIKTOK_INSTANT_PAGE` or set `business_types` to `["TIKTOK_INSTANT_PAGE"]` in the request. | |
| destination_urls | string[] | Returned when your `business_type` is`LEAD_GEN`(Instant Form), `APP_PROFILE_PAGE` (App Profile Page), or `TIKTOK_INSTANT_PAGE` (Custom Page or Custom TikTok Instant Page). Destination URLs. | |
| messaging_app_type | string | The type of instant messaging app associated with the TikTok Instant Page. Enum values: - `MESSENGER`: Messenger. - `WHATSAPP`: WhatsApp. - `IM_URL`: No instant messaging app is associated with the TikTok Instant Page. | |
| messaging_app_account_id | string | The ID of the instant messaging app account associated with the TikTok Instant Page. - When `messaging_app_type` is `MESSENGER`, this field represents the Facebook Page ID. - When `messaging_app_type` is `WHATSAPP`, this field represents the WhatsApp phone number. - When `messaging_app_type` is `IM_URL`, this field will be an empty string (`""`). | |
| transfer_status | string | Whether the page has been transferred to Business Center. Enum values: `UNSET`, `TRANSFERRED` | |
| user_id | string | ID of the user who created the page. | |
| is_associated | boolean | Whether Storefront Page has been associated with some ad (Storefront Page cannot be reused, and each page can only be associated with one ad). | |
| duplicate_id | string | Duplicate source page ID. | |
| page_info | object | Pagination information. | |
| page | number | Current page. | |
| page_size | number | Page size. | |
| total_number | number | Total number of results. | |
| total_page | number | Total number of pages. | |
| request_id | string | Log id of the request, uniquely identifying a request. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"list": [
{
"create_time": "{{create_time}}",
"destination_urls": [],
"duplicate_id": "{{duplicate_id}}",
"page_id": "{{page_id}}",
"preview_url": "{{preview_url}}",
"publish_time": "{{publish_time}}",
"status": "PUBLISHED",
"supported_objectives": [
"LEAD_GENERATION"
],
"template_id": "{{template_id}}",
"template_name": "{{template_name}}",
"thumbnail": "{{thumbnail}}",
"title": "{{title}}",
"transfer_status": "UNSET",
"update_time": "{{update_time}}",
"user_id": "{{user_id}}"
}
],
"page_info": {
"page": 1,
"page_size": 10,
"total_number": 1,
"total_page": 1
}
}
}
(/code);
Get started
- Sign up for Partner
- Enable a data type of the Ads (Marketing API) group on the platform page
- Create an API key (tick the TikTok Business channel)
- Call it as in the examples above