# SymphonyOS API Documentation

> Bring automated marketing to your customers with the SymphonyOS API.

## Guides: Getting Started
- [Getting Started](https://docs.symphonyos.co/docs/getting-started.md): Help your customers grow faster with automated marketing through the SymphonyOS API.
  - [Get an API Key](https://docs.symphonyos.co/docs/get-an-api-key.md)
  - [Authentication](https://docs.symphonyos.co/docs/authentication.md)
  - [Rate Limits & Error Handling](https://docs.symphonyos.co/docs/rate-limits-error-handling.md)
  - [FAQ](https://docs.symphonyos.co/docs/faq.md)

## Guides: Advertising API
- [Overview](https://docs.symphonyos.co/docs/advertising-api.md): Programmatically create and manage ad campaigns on Meta and TikTok through a single unified interface.
- [Integration Guide](https://docs.symphonyos.co/docs/integration-guide.md): Step-by-step guide to integrating with the Symphony Advertising API.
- [Connecting Ad Platforms](https://docs.symphonyos.co/docs/connecting-ad-platforms.md): Set up Meta and TikTok ad platform connections for your brands.
  - [Integrating Facebook Login](https://docs.symphonyos.co/docs/integrating-facebook-login.md): Allow users to login to Facebook and select their own ad accounts.
  - [Option 1 + 2: Use Your Ad Accounts + Pages](https://docs.symphonyos.co/docs/option-1-use-your-ad-accounts-pages.md)
  - [Option 3: Hybrid Connection](https://docs.symphonyos.co/docs/option-3-hybrid-connection.md)
- [Create Campaigns](https://docs.symphonyos.co/docs/create-campaigns.md)
  - [Campaign with custom Facebook page + Ad account](https://docs.symphonyos.co/docs/campaign-with-custom-facebook-page-ad-account.md)
- [Conversions API](https://docs.symphonyos.co/docs/conversion-api.md)
- [Webhooks](https://docs.symphonyos.co/docs/webhooks.md): Receive real-time notifications for campaign lifecycle events.
  - [Handling Events](https://docs.symphonyos.co/docs/handling-events.md)
- [Common Use Cases](https://docs.symphonyos.co/docs/common-use-cases.md): Worked examples showing complete request/response flows for common advertising scenarios.

## Guides: Ad Box
- [Ad Box](https://docs.symphonyos.co/docs/ad-box.md)
  - [Integration Options](https://docs.symphonyos.co/docs/integration-options.md)
  - [Customization](https://docs.symphonyos.co/docs/customization-options.md)

## Guides: Use Cases
- [Use Cases](https://docs.symphonyos.co/docs/what-you-can-build.md)

## API Reference: Advertising API
- [Get campaign](https://docs.symphonyos.co/reference/get-current-campaign.md)
- [Get campaign markets locations](https://docs.symphonyos.co/reference/campaing-market-get.md)
- [Check Campaign](https://docs.symphonyos.co/reference/check-campaign.md)
- [Get Campaign List filtered](https://docs.symphonyos.co/reference/campaign-filter.md)
- [Create Campaign](https://docs.symphonyos.co/reference/post_advertising-v1-campaign.md)
- [Add target location to campaign](https://docs.symphonyos.co/reference/target-location-add.md)
- [Pause Campaign market location](https://docs.symphonyos.co/reference/pause-location.md)
- [Pause or activate campaign](https://docs.symphonyos.co/reference/pause-campaign.md)
- [Update budget and/or end_date](https://docs.symphonyos.co/reference/update-budget-campaign.md)
- [Get Instagram Posts](https://docs.symphonyos.co/reference/instagram-post.md)
- [Search location by keyword](https://docs.symphonyos.co/reference/location-key.md)
- [Search Artist by keyword](https://docs.symphonyos.co/reference/artist.md): It is necessary to first consult the endpoint to obtain a Spotify artist since the keyword is required and it is necessary to pass the full name of the artist
- [Search Language by keyword](https://docs.symphonyos.co/reference/language-meta.md)
- [Search Interests by keyword](https://docs.symphonyos.co/reference/interest_search.md)
- [Search Interests suggestions by interest list](https://docs.symphonyos.co/reference/interest_suggestion_search.md)
- [Get ad accounts from page connected to user brand](https://docs.symphonyos.co/reference/ad-accounts-meta.md)
- [Get facebook pages from page connected to user brand](https://docs.symphonyos.co/reference/facebook-pages-meta.md)
- [Get facebook pages from page connected to user brand by fb_user_id](https://docs.symphonyos.co/reference/facebook-pages-meta-by-fb_user_id.md)
- [Get Instagram Posts by fb_user_id and fb_page_id](https://docs.symphonyos.co/reference/instagram-post-by-fb-user-id-and-fb-page-id.md)
- [Get connected facebook page and ad accounts](https://docs.symphonyos.co/reference/facebook-pages-meta-connected.md)
- [Get connected facebook page and instagram page](https://docs.symphonyos.co/reference/facebook-pages-meta-connected-hybrid.md)
- [Connect brand to facebook based on token from sdk](https://docs.symphonyos.co/reference/facebook-connect-brand-meta.md)
- [Get Record content in brand by keyword](https://docs.symphonyos.co/reference/get-record.md)
- [Search artist in spotify](https://docs.symphonyos.co/reference/spotify-artist.md)
- [Get country list](https://docs.symphonyos.co/reference/youtube-country-list.md)
- [Get Analytic Creative Performance](https://docs.symphonyos.co/reference/cretive-performance.md)
- [Get campaign Detail](https://docs.symphonyos.co/reference/detail-campaign.md)
- [Get Facebook Ad Media Analytic](https://docs.symphonyos.co/reference/facebook_ad_media.md)

## API Reference: Partners API - Symphony
- [Get partner](https://docs.symphonyos.co/reference/get-partner.md)
- [Get webhooks](https://docs.symphonyos.co/reference/get-webhooks.md)
- [Create webhook](https://docs.symphonyos.co/reference/create-webhook.md)
- [Update webhook](https://docs.symphonyos.co/reference/update-webhook.md)
- [Delete webhook](https://docs.symphonyos.co/reference/delete-webhook.md)
- [Get partner](https://docs.symphonyos.co/reference/get-partner-1.md)
- [Get webhooks](https://docs.symphonyos.co/reference/get-webhooks-1.md)
- [Create webhook](https://docs.symphonyos.co/reference/create-webhook-1.md)
- [Update webhook](https://docs.symphonyos.co/reference/update-webhook-1.md)
- [Delete webhook](https://docs.symphonyos.co/reference/delete-webhook-1.md)
- [Get Instagram Posts](https://docs.symphonyos.co/reference/instagram-post-1.md)
- [Search location by keyword](https://docs.symphonyos.co/reference/location-key-1.md)
- [Search Artist by keyword](https://docs.symphonyos.co/reference/artist-1.md): It is necessary to first consult the endpoint to obtain a Spotify artist since the keyword is required and it is necessary to pass the full name of the artist
- [Search Interests by keyword](https://docs.symphonyos.co/reference/interest_search-1.md)
- [Search Interests suggestions by interest list](https://docs.symphonyos.co/reference/interest_suggestion_search-1.md)
- [Search Language by keyword](https://docs.symphonyos.co/reference/language-meta-1.md)
- [Get ad accounts from page connected to user brand](https://docs.symphonyos.co/reference/ad-accounts-meta-1.md)
- [Get facebook pages from page connected to user brand](https://docs.symphonyos.co/reference/facebook-pages-meta-1.md)
- [Get facebook pages from page connected to user brand by fb_user_id](https://docs.symphonyos.co/reference/facebook-pages-meta-by-fb_user_id-1.md)
- [Get Instagram Posts by fb_user_id and fb_page_id](https://docs.symphonyos.co/reference/instagram-post-by-fb-user-id-and-fb-page-id-1.md)
- [Get connected facebook page and ad accounts](https://docs.symphonyos.co/reference/facebook-pages-meta-connected-1.md)
- [Get connected facebook page and instagram page](https://docs.symphonyos.co/reference/facebook-pages-meta-connected-hybrid-1.md)
- [Connect brand to facebook based on token from sdk](https://docs.symphonyos.co/reference/facebook-connect-brand-meta-1.md)
- [Get Record content in brand by keyword](https://docs.symphonyos.co/reference/get-record-1.md)
- [Search artist in spotify](https://docs.symphonyos.co/reference/spotify-artist-1.md)
- [Create Campaign](https://docs.symphonyos.co/reference/post_advertising-v1-campaign-1.md)
- [Get Campaign List filtered](https://docs.symphonyos.co/reference/campaign-filter-1.md)
- [Check Campaign](https://docs.symphonyos.co/reference/check-campaign-1.md)
- [Add target location to campaign](https://docs.symphonyos.co/reference/target-location-add-1.md)
- [Get campaign markets locations](https://docs.symphonyos.co/reference/campaing-market-get-1.md)
- [Pause Campaign market location](https://docs.symphonyos.co/reference/pause-location-1.md)
- [Get campaign](https://docs.symphonyos.co/reference/get-current-campaign-1.md)
- [Update budget and/or end_date](https://docs.symphonyos.co/reference/update-budget-campaign-1.md)
- [Pause or activate campaign](https://docs.symphonyos.co/reference/pause-campaign-1.md)
- [Get country list](https://docs.symphonyos.co/reference/youtube-country-list-1.md)
- [Get Analytic Creative Performance](https://docs.symphonyos.co/reference/cretive-performance-1.md)
- [Get campaign Detail](https://docs.symphonyos.co/reference/detail-campaign-1.md)
- [Get Facebook Ad Media Analytic](https://docs.symphonyos.co/reference/facebook_ad_media-1.md)

## API Reference: Symphony Advertising API
- [Create a campaign](https://docs.symphonyos.co/reference/createcampaign.md): Creates a new ad campaign on the specified platform. The campaign is saved immediately and the response is returned, while the actual submission to Meta or TikTok happens asynchronously in the…
- [List all campaigns](https://docs.symphonyos.co/reference/listcampaigns.md): Returns all campaigns associated with your API key across all brands.
- [Get a campaign](https://docs.symphonyos.co/reference/getcampaign.md): Returns details for a single campaign by ID.
- [Update a campaign](https://docs.symphonyos.co/reference/updatecampaign.md): Update a running campaign's budget, end date, or pause state. You can include multiple fields in a single request.  Each field that is provided will be updated independently. A `campaign.updated`…
- [Get campaign analytics](https://docs.symphonyos.co/reference/getcampaignanalytics.md): Returns performance analytics for a campaign. The data shape depends on the ad platform.
- [Create a campaign](https://docs.symphonyos.co/reference/createcampaign-1.md): Creates a new ad campaign on the specified platform. The campaign is saved immediately and the response is returned, while the actual submission to Meta or TikTok happens asynchronously in the…
- [List all campaigns](https://docs.symphonyos.co/reference/listcampaigns-1.md): Returns all campaigns associated with your API key across all brands.
- [Get a campaign](https://docs.symphonyos.co/reference/getcampaign-1.md): Returns details for a single campaign by ID.
- [Update a campaign](https://docs.symphonyos.co/reference/updatecampaign-1.md): Update a running campaign's budget, end date, or pause state. You can include multiple fields in a single request.  Each field that is provided will be updated independently. A `campaign.updated`…
- [Get campaign analytics](https://docs.symphonyos.co/reference/getcampaignanalytics-1.md): Returns performance analytics for a campaign. The data shape depends on the ad platform.
- [Search interests](https://docs.symphonyos.co/reference/searchinterests.md): Search for interest-based audiences on a given ad platform.  **Meta** returns `InterestAudience` results only. **TikTok** returns both `InterestAudience` and `HashtagAudience` results.
- [Search geographies](https://docs.symphonyos.co/reference/searchgeographies.md): Search for geographic locations (countries, regions, cities) to use in campaign targeting.
- [Search languages](https://docs.symphonyos.co/reference/searchlanguages.md): Search for languages to use in campaign targeting.
- [Search interests](https://docs.symphonyos.co/reference/searchinterests-1.md): Search for interest-based audiences on a given ad platform.  **Meta** returns `InterestAudience` results only. **TikTok** returns both `InterestAudience` and `HashtagAudience` results.
- [Search geographies](https://docs.symphonyos.co/reference/searchgeographies-1.md): Search for geographic locations (countries, regions, cities) to use in campaign targeting.
- [Search languages](https://docs.symphonyos.co/reference/searchlanguages-1.md): Search for languages to use in campaign targeting.
- [Get brands](https://docs.symphonyos.co/reference/getbrands.md): Returns brands associated with your API key.  If `brandId` is provided as a query parameter, returns that specific brand. Otherwise returns all brands for your API key.
- [Create a brand](https://docs.symphonyos.co/reference/createbrand.md): Creates a new brand associated with your API key. The brand is auto-named with a unique identifier.  After creation, use `PUT /brands` to connect ad platform accounts.
- [Connect ad platform to brand](https://docs.symphonyos.co/reference/updatebrand.md): Registers an ad platform access token with a brand. This connects the brand to Meta or TikTok so campaigns can be created.  **Note:** This endpoint is in active development. During the beta period,…
- [Get campaigns for a brand](https://docs.symphonyos.co/reference/getbrandcampaigns.md): Returns all campaigns for a specific brand. If `brandId` is omitted, uses the default brand for your API key.
- [Get brands](https://docs.symphonyos.co/reference/getbrands-1.md): Returns brands associated with your API key.  If `brandId` is provided as a query parameter, returns that specific brand. Otherwise returns all brands for your API key.
- [Create a brand](https://docs.symphonyos.co/reference/createbrand-1.md): Creates a new brand associated with your API key. The brand is auto-named with a unique identifier.  After creation, use `PUT /brands` to connect ad platform accounts.
- [Connect ad platform to brand](https://docs.symphonyos.co/reference/updatebrand-1.md): Registers an ad platform access token with a brand. This connects the brand to Meta or TikTok so campaigns can be created.  **Note:** This endpoint is in active development. During the beta period,…
- [Get campaigns for a brand](https://docs.symphonyos.co/reference/getbrandcampaigns-1.md): Returns all campaigns for a specific brand. If `brandId` is omitted, uses the default brand for your API key.
- [List webhooks](https://docs.symphonyos.co/reference/listwebhooks.md): Returns all webhooks registered for your API key.
- [Create a webhook](https://docs.symphonyos.co/reference/createwebhook.md): Registers a new webhook to receive campaign lifecycle events.  **Available event types:** `campaign.created`, `campaign.updated`, `campaign.processing`, `campaign.completed`, `campaign.failed`  Note:…
- [Update a webhook](https://docs.symphonyos.co/reference/updatewebhook.md): Updates the URL for an existing webhook. The webhook status is reset to `pending`.
- [Delete a webhook](https://docs.symphonyos.co/reference/deletewebhook.md): Permanently removes a webhook subscription.
- [List webhooks](https://docs.symphonyos.co/reference/listwebhooks-1.md): Returns all webhooks registered for your API key.
- [Create a webhook](https://docs.symphonyos.co/reference/createwebhook-1.md): Registers a new webhook to receive campaign lifecycle events.  **Available event types:** `campaign.created`, `campaign.updated`, `campaign.processing`, `campaign.completed`, `campaign.failed`  Note:…
- [Update a webhook](https://docs.symphonyos.co/reference/updatewebhook-1.md): Updates the URL for an existing webhook. The webhook status is reset to `pending`.
- [Delete a webhook](https://docs.symphonyos.co/reference/deletewebhook-1.md): Permanently removes a webhook subscription.
- [Test API connection](https://docs.symphonyos.co/reference/testconnection.md): Health check endpoint to verify your API key is valid and the service is reachable.
- [Test API connection](https://docs.symphonyos.co/reference/testconnection-1.md): Health check endpoint to verify your API key is valid and the service is reachable.