PEpeec
Project

List Brands

Changed on

List the brands of a project

get/brands

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/brands
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Query parameters

project_idstring

Required if using a company api key

Example:or_f45b94ba-5e35-4982-93ed-285e72ee14eb
limitinteger
offsetinteger

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
}

Changes

  • 9fdffdff48a5Revision changes
    • breaking

      for the query request parameter limit, the type changed from number to integer

    • breaking

      for the query request parameter offset, the type changed from number to integer

    • warning

      for the query request parameter offset, the max was set to 9007199254740991.00

    • info

      added the optional property // to the response with the status