List platform integration campaigns for a given account

Make a call to external platform API to retrieve a list of campaigns available for the given account.

Response Format:

• Google Ads: Returns asset groups (campaigns). The details field is null.
• TikTok: Returns campaigns with their associated ad groups. Each item represents one search campaign. The details field contains:

  {
    "ad_groups": [
      {
        "id": "string",
        "name": "string"
      }
    ]
  }
  

TikTok Response Structure:

• id: Campaign ID (unique identifier for the campaign)
• name: Campaign name
• campaign_id: Campaign ID
• details.ad_groups: List of ad group objects, each containing:
  • id: Ad group ID
  • name: Ad group name

Note: Campaigns with no ad groups are skipped for TikTok.

POST /v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/{id}/campaigns

List platform integration campaigns for a given account

cURL

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_integrations/{id}/campaigns \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "<string>"
}
'

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "platform": "<string>",
    "account_id": "<string>",
    "campaign_id": "<string>",
    "platform_integration_id": "<string>",
    "details": {}
  }
]

Authorizations

Authorization · string · header · required

Path Parameters

id · string<uuid> · required

A UUID string identifying this platform integration.

organization_id · string<uuid> · required

A UUID string identifying the organization.

workspace_id · string<uuid> · required

A UUID string identifying the workspace.

Body

application/json

account_id · string · required

The ID of the account.

Response

200

application/json

A list of campaigns associated with the account. For TikTok, each campaign includes its ad groups in the details field.

id · string · required

name · string · required

platform · string · required

account_id · string · required

campaign_id · string · required

platform_integration_id · string · required

The ID of the platform integration associated with this account.

details · object

Show child attributes