Developer resources

Get CRM Event Sets — TikTok Business API

Get CRM Event Sets · 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 CRM Event Sets

GET/crm/list/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/crm/list/

Description

Use this endpoint to get a list of CRM (Customer relationship management) Event Sets within an advertiser account. You can filter results by CRM Event Set ID or name.

> Important

> By using Events API endpoints, you agree to the TikTok Business Products (Data) Terms and that you will not share sensitive data with TikTok.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/crm/list/

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
name	query	string	No		The CRM Event Set name to filter the results by. Length limit: 1-40 characters. Exact match is supported. - If this field is not passed, all CRM Event Sets within the advertiser account will be returned. - If you pass a name that cannot be matched, the results will be empty.
event_set_ids	query	string[]	No		The list of CRM Event Set IDs to filter the results by. Max size: 50. Exact match is supported. - If this field is not passed, all CRM Event Sets within the advertiser account will be returned. - Only the CRM Event Sets that match the IDs you specify in this field will be returned. Unmatched IDs will be excluded from the returned results. - If you pass both `event_set_ids` and `name`, the result will be either one event set that matches the specified name and has an ID that corresponds to one of the specified event set IDs, or empty if no event set meets the criteria. Note: The maximum number of CRM Event Sets allowed within an advertiser account is 50.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/crm/list/" \
  -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/crm/list/",
    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/crm/list/');
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/crm/list/' . '?' . 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	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.
crm_event_sets	object[]	The list of matched CRM Event Sets within the advertiser account.
event_set_id	string	The ID of the CRM Event Set.
name	string	The name of the CRM Event Set.
create_time	string	The time when the CRM Event Set was created, in ISO-8601 format. Example: `"2023-04-15T00:23:38Z"`.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "crm_event_sets": [
            {
                "event_set_id": "{{event_set_id}}",
                "name": "{{name}}",
                "create_time": "2023-10-06T08:42:36Z"
            },
            {
                "event_set_id": "{{event_set_id}}",
                "name": "{{name}}",
                "create_time": "2023-12-07T14:45:07Z"
            }
        ]
    }
}

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