The shop's target collaborations, one page per call
GET
/api/public/v1/tik_tok_shop/target_collabsConnectorAnswers empty results in the documented shape until the brand switches on this connection.
Operation id listTikTokShopTargetCollabs
Request
curl
curl "https://creator.growthdept.ai/api/public/v1/tik_tok_shop/target_collabs?status=ONGOING" \
-H "Authorization: Bearer gdc_..."Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| status | query | string | requiredOne of ONGOINGEXPIRINGVALIDCANCELINGCOMPLETED |
| keyword | query | string | |
| keywordType | query | string | One of PRODUCT_IDPRODUCT_NAMETARGET_COLLABORATION_IDTARGET_COLLABORATION_NAME |
| creatorOpenId | query | string | |
| creatorAcceptStatus | query | string | One of ACCEPTALL |
| freeSampleSetting | query | string | One of WITH_FREE_SAMPLEALL |
| pageSize | query | integer | One of 2050100 Default 100 |
| cursor | query | string | |
| organization_id | query | integer |
Responses
200Success
| Field | Type | Notes |
|---|---|---|
| collabs | array of object | required |
| collabs[].[].counts | object | |
| collabs[].[].counts.contentCreators | integer, nullable | |
| collabs[].[].counts.invited | integer, nullable | |
| collabs[].[].counts.products | integer, nullable | |
| collabs[].[].counts.showcaseCreators | integer, nullable | |
| collabs[].[].createTime | integer, nullable | |
| collabs[].[].endTime | integer, nullable | |
| collabs[].[].freeSampleRule | object, nullable | |
| collabs[].[].freeSampleRule.hasFreeSample | boolean | |
| collabs[].[].freeSampleRule.isSampleApprovalExempt | boolean | |
| collabs[].[].id | string, nullable | |
| collabs[].[].message | string, nullable | |
| collabs[].[].name | string, nullable | |
| collabs[].[].startTime | integer, nullable | |
| collabs[].[].type | string, nullable | |
| collabs[].[].updateTime | integer, nullable | |
| hasMore | boolean | required |
| nextCursor | string, nullable | required |
| source | string | requiredOne of officialweb |
| totalCount | integer, nullable | required |
Example
{
"collabs": [
{
"counts": {
"contentCreators": 3,
"invited": 3,
"products": 3,
"showcaseCreators": 3
},
"createTime": 3,
"endTime": 3,
"freeSampleRule": {
"hasFreeSample": true,
"isSampleApprovalExempt": true
},
"id": "string",
"message": "string",
"name": "Example name",
"startTime": 3,
"type": "string",
"updateTime": 3
}
],
"hasMore": true,
"nextCursor": "string",
"source": "official",
"totalCount": 3
}Errors: 400401403404422429502with an error and usually a message. See errors.
Example values are made up from each field's type and name.