v1

latestOpenAPI 3.0.32026-07-26710398.3 KB
Project

List Brands

List the brands of a project

get/brands

Query parameters

project_idstring

Required if using a company api key

Example:or_f45b94ba-5e35-4982-93ed-285e72ee14eb
limitnumber
offsetnumber

Response

Success

total_countnumber required

Total number of brands, ignoring pagination

totalCountnumber required

Total number of brands, ignoring pagination

Example response

{
  "data": [
    {
      "id": "kw_915e742b-396d-4a86-ad57-8bc84e8c2232",
      "name": "Peec AI",
      "domains": [
        "peec.ai"
      ],
      "aliases": [
        "Peec"
      ],
      "color": "#3b82f6",
      "source": "manual"
    }
  ],
  "total_count": 42,
  "totalCount": 42
}