Target collaborations

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "collabs": [
    {
      "id": "7390000000000000001",
      "name": "Summer serum push",
      "message": "Loved your skincare videos",
      "startTime": 1756684800,
      "endTime": 1759276800,
      "createTime": 1756684800,
      "updateTime": 1756771200,
      "type": "STANDARD",
      "counts": {
        "invited": 50,
        "showcaseCreators": 12,
        "contentCreators": 4,
        "products": 3
      },
      "freeSampleRule": {
        "hasFreeSample": true,
        "isSampleApprovalExempt": false
      }
    }
  ],
  "totalCount": 132,
  "nextCursor": "b2Zmc2V0PTIwCg",
  "hasMore": true,
  "source": "official"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Target collaborations

Lists the shop’s target collaborations, one page per call, including ones created in Seller Center. Each row has id, name, the invite message, startTime, endTime, createTime and updateTime (Unix seconds), type (STANDARD or TOP_CREATOR_PROGRAM), counts (invited, showcase creators, content creators, products) and freeSampleRule.

status is required: ONGOING (more than 7 days left), EXPIRING (under 7 days left), VALID (both), CANCELING or COMPLETED. VALID collabs count toward TikTok’s 10,000 cap. Rows don’t carry their own status. Filter with keyword plus keywordType (PRODUCT_ID, PRODUCT_NAME, TARGET_COLLABORATION_ID or TARGET_COLLABORATION_NAME; the name types are fuzzy), creatorOpenId, creatorAcceptStatus and freeSampleSetting. pageSize is 20, 50 or 100 (default 100). Pass nextCursor back as cursor. For shops connected without TikTok’s official API, only ONGOING, EXPIRING or COMPLETED with no other filter work, and fields are best effort (source: web). Read live from TikTok.

GET

tik_tok_shop

target_collabs

Target collaborations

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "collabs": [
    {
      "id": "7390000000000000001",
      "name": "Summer serum push",
      "message": "Loved your skincare videos",
      "startTime": 1756684800,
      "endTime": 1759276800,
      "createTime": 1756684800,
      "updateTime": 1756771200,
      "type": "STANDARD",
      "counts": {
        "invited": 50,
        "showcaseCreators": 12,
        "contentCreators": 4,
        "products": 3
      },
      "freeSampleRule": {
        "hasFreeSample": true,
        "isSampleApprovalExempt": false
      }
    }
  ],
  "totalCount": 132,
  "nextCursor": "b2Zmc2V0PTIwCg",
  "hasMore": true,
  "source": "official"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status

enum<string>

required

ONGOING = more than 7 days left, EXPIRING = under 7 days left, VALID = both, CANCELING = being cancelled, COMPLETED = expired or cancelled.

Available options:

ONGOING,

EXPIRING,

VALID,

CANCELING,

COMPLETED

keyword

string

Search text. Requires keywordType.

keywordType

enum<string>

What keyword matches. The two NAME types are fuzzy; the two ID types are exact. Requires keyword.

Available options:

PRODUCT_ID,

PRODUCT_NAME,

TARGET_COLLABORATION_ID,

TARGET_COLLABORATION_NAME

creatorOpenId

string

Only collabs this creator (TikTok open id) was invited to.

creatorAcceptStatus

enum<string>

ACCEPT = only collabs where invited creators added the products to their showcase. TikTok default ALL.

Available options:

ACCEPT,

ALL

freeSampleSetting

enum<string>

WITH_FREE_SAMPLE = only collabs that offer free samples. TikTok default ALL.

Available options:

WITH_FREE_SAMPLE,

ALL

pageSize

enum<integer>

default:100

Rows per page. TikTok accepts only 20, 50 or 100.

Available options:

20,

50,

100

cursor

string

The previous response's nextCursor.

organization_id

integer

Use the TikTok Shop of this child brand (organization id) of your API key's organization

Response

One page of collaborations

collabs

object[]

required

Show child attributes

totalCount

integer | null

required

TikTok's total for this filter across all pages.

nextCursor

string | null

required

Pass back as cursor for the next page; null on the last page.

hasMore

boolean

required

source

enum<string>

required

official = TikTok's API; web = the Seller Center list for a token-less shop (best-effort fields).

Available options:

official,

web

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Target collaborations

Authorizations

Query Parameters

Response