Developer resources

Get fields of an Instant Form or direct message leads — TikTok Business API

Get fields of an Instant Form or direct message leads · 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.

Open in the API index TikTok Business platform page

Get fields of an Instant Form or direct message leads

GET/lead/field/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/lead/field/get/

Description

Use this endpoint to retrieve the fields of an Instant Form or direct message leads.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/lead/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	Description
lead_source	query	string	Yes	The source of the leads. Enum values: - `INSTANT_FORM`: leads generated through an Instant Form. - `DIRECT_MESSAGE`: leads generated from direct messages of the associated Business Account.
library_id	query	string	No	Required when the leads are under a form library of a Business Center. ID of a form library. To obtain the list of form libraries within a Business Center, use /page/library/get/.
page_id	query	string	No	- Required when `lead_source` is `INSTANT_FORM`. - Not supported when `lead_source` is `DIRECT_MESSAGE`. The page ID of an Instant Form. To obtain a list of Instant Forms, use /page/get/ and set `business_type` to `LEAD_GEN`.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/lead/field/get/?lead_source=" \
  -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/lead/field/get/",
    params={
        "lead_source": ""
    },
    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/lead/field/get/');
for (const [k, v] of Object.entries({"lead_source":""})) 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/lead/field/get/' . '?' . http_build_query(['lead_source' => '']);
$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	Description
code	number	Response code. For the complete list of response codes and descriptions, see Appendix-Return Code.
message	string	Response message. For details, see Appendix - Return Codes.
request_id	string	The log ID of a request, which uniquely identifies the request.
data	object	Returned data.
fields	string[]	The fields of the Instant Form or direct message leads. Note: The data within this string array depends on the questions that you have set in the Instant Form or the questions collected in the direct message leads.
meta_data	object	Metadata about the Instant Form or direct message leads.
create_time	string	The time when the Instant Form was created or when the direct message lead was collected, in the format of `YYYY-MM-DD HH:MM:SS` (UTC+0 time). Example: `2025-01-01 00:00:01`.
page_id	string	The page ID of the Instant Form. When `lead_source` is `DIRECT_MESSAGE` in the request, this field will be `"0"`.
page_name	string	The page name of the Instant Form. When `lead_source` is `DIRECT_MESSAGE` in the request, this field will be an empty string (`""`).
page_url	string	The URL of the Instant Form. When `lead_source` is `DIRECT_MESSAGE` in the request, this field will be an empty string (`""`).

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "fields": [
            "email"
        ],
        "meta_data": {
            "create_time": "{{create_time}}",
            "page_id": "{{page_id}}",
            "page_name": "{{page_name}}",
            "page_url": "{{page_url}}"
        }
    }
}

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