---
updatedAt: 2026-03-04T21:49:24.000Z
agentTools:
  projectIndex: https://docs.symphonyos.co/llms.txt
---

# Get brands

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.


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Symphony Advertising API",
    "version": "2.0.0",
    "description": "Programmatically create and manage ad campaigns on Meta (Facebook/Instagram) and TikTok through a single unified interface.\n\n## Authentication\nAll endpoints require an `x-api-key` header with your Symphony API key.\n\n## Base URL\n`https://api.symphonyos.co/v2/sym/v2/`\n\n## Unified Interface\nThe Advertising API uses a single `CampaignInput` schema for both Meta and TikTok. You specify the `adPlatform` (\"meta\" or \"tiktok\") and Symphony handles all platform-specific translation.\n\n## Async Campaign Creation\nCampaign creation returns immediately with a campaign record. The actual submission to the ad platform happens asynchronously in the background. Monitor status via `GET /campaigns/{campaignId}` or webhooks.\n",
    "contact": {
      "name": "Symphony Partnerships",
      "email": "partnerships@symphonyos.co"
    }
  },
  "servers": [
    {
      "url": "https://api.symphonyos.co/v2/sym/v2",
      "description": "Production"
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Brands",
      "description": "Manage brands and their ad platform connections"
    }
  ],
  "paths": {
    "/brands": {
      "get": {
        "operationId": "getBrands",
        "tags": [
          "Brands"
        ],
        "summary": "Get brands",
        "description": "Returns brands associated with your API key.\n\nIf `brandId` is provided as a query parameter, returns that specific brand. Otherwise returns all brands for your API key.\n",
        "parameters": [
          {
            "name": "brandId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "description": "Optional brand ID to filter by.",
            "example": 12345
          }
        ],
        "responses": {
          "200": {
            "description": "Brands retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": true
                    },
                    "data": {
                      "oneOf": [
                        {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "integer",
                              "example": 12345
                            }
                          }
                        },
                        {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "integer"
                              }
                            }
                          }
                        }
                      ],
                      "description": "A single brand object (when `brandId` is provided) or an array of brand objects."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "500": {
            "$ref": "#/components/responses/ServerError"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key",
        "description": "Your Symphony API key. Contact partnerships@symphonyos.co to request access."
      }
    },
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean",
            "example": false
          },
          "message": {
            "type": "string",
            "description": "Human-readable error description."
          },
          "error": {
            "type": "string",
            "description": "Raw error message (included on 500 errors)."
          }
        }
      }
    },
    "responses": {
      "Unauthorized": {
        "description": "Missing or invalid API key",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "success": false,
              "message": "Unauthorized"
            }
          }
        }
      },
      "NotFound": {
        "description": "Resource not found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "success": false,
              "message": "Campaign 99999 not found"
            }
          }
        }
      },
      "ServerError": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResponse"
            },
            "example": {
              "success": false,
              "message": "An error occurred while processing request",
              "error": "Internal error details"
            }
          }
        }
      }
    }
  }
}
```