Core API
- GETGoogle Ads OAuth callback
- GETTikTok OAuth callback
- GETList platform integrations
- POSTCreate a platform integration
- GETRetrieve platform integration
- DELDelete platform integration
- GETList all accounts accessible with the platform integration
- POSTList platform integration campaigns for a given account
- GETInitiate Google Ads OAuth flow
- GETGoogle Ads OAuth callback
- GETInitiate TikTok OAuth flow
- GETTikTok OAuth callback
Search API
List platform integration campaigns for a given account
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>"
}
'[
{
"id": "<string>",
"name": "<string>",
"platform": "<string>",
"account_id": "<string>",
"campaign_id": "<string>",
"platform_integration_id": "<string>",
"details": {}
}
]Platform Integrations
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
detailsfield isnull. - TikTok: Returns campaigns with their associated ad groups. Each item represents one search campaign.
The
detailsfield contains:{ "ad_groups": [ { "id": "string", "name": "string" } ] }
TikTok Response Structure:
id: Campaign ID (unique identifier for the campaign)name: Campaign namecampaign_id: Campaign IDdetails.ad_groups: List of ad group objects, each containing:id: Ad group IDname: 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 --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>"
}
'[
{
"id": "<string>",
"name": "<string>",
"platform": "<string>",
"account_id": "<string>",
"campaign_id": "<string>",
"platform_integration_id": "<string>",
"details": {}
}
]Documentation Index
Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Path Parameters
A UUID string identifying this platform integration.
A UUID string identifying the organization.
A UUID string identifying the workspace.
Body
application/json
The ID of the account.
Response
A list of campaigns associated with the account. For TikTok, each campaign includes its ad groups in the details field.
List all accounts accessible with the platform integration
Previous
Initiate Google Ads OAuth flow
Next
⌘I