Get the fields of an Instant Form
GET/page/field/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/page/field/get/
Description
Use this endpoint to get the fields of an Instant Form (or lead form).
To retrieve the Instant Form fields, you can also choose to create a mock lead using /page/lead/mock/create/ and then extract the field names. However, we recommend you use this endpoint to get Instant Form fields directly.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/page/field/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 |
|---|---|---|---|---|---|
| page_id | query | string | Yes | The ID of the Instant Form. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/page/field/get/?page_id=" \ -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/field/get/",
params={
"page_id": ""
},
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/field/get/');
for (const [k, v] of Object.entries({"page_id":""})) 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/field/get/' . '?' . http_build_query(['page_id' => '']); $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 | The response code. For the complete list of response codes and descriptions, see Appendix - Return Codes. | |
| message | string | The response message. For details, see Appendix - Return Codes. | |
| data | object | The returned data. | |
| fields | string | The Instant Form fields. | |
| meta_data | object | Metadata about the Instant Form. | |
| page_id | string | The Instant Form ID. | |
| create_time | datetime | The creation time of the Instant Form. | |
| page_name | string | Page title. | |
| page_url | string | Instant Form URL. | |
| request_id | string | The unique ID of the request, which uniquely identifies a request. |
Response sample
HTTPS/1.1 200 OK
{
"message": "OK",
"data": {
"fields": [],
"meta_data": {}
}
}
(/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