Skip to main content
GET
/
global-brands
List Global Brands
curl --request GET \
  --url https://api.peec.ai/customer/v1/global-brands \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "019ecb6e-d030-7222-b531-b371fe9db583",
      "name": "Nike",
      "domain": "nike.com",
      "description": "American athletic footwear and apparel company"
    }
  ],
  "total_count": 42,
  "totalCount": 42
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
project_id
string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

​
search
string

Search the catalog by brand name (matches names and aliases). The primary way to use this endpoint.

Example:

"nike"

​
limit
number
default:1000
Required range: 1 <= x <= 10000
​
offset
number
default:0
Required range: x >= 0

Response

200 - application/json

Success

Success

​
data
object[]
required
​
total_count
number
required

Total number of matching brands, ignoring pagination

Example:

42

​
totalCount
number
required
deprecated

Total number of matching brands, ignoring pagination

Example:

42