Skip to main content
GET
/
categories
List Categories
curl --request GET \
  --url https://api.peec.ai/customer/v1/categories \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "0190f9a1-1d8c-7e3a-9c2b-1f0a2b3c4d5e",
      "name": "Running Shoes",
      "path": "Footwear > Shoes > Running Shoes",
      "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "total_count": 123
}

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"

Response

200 - application/json

The project's categories as a flat tree

The project's categories as a flat tree

data
object[]
required
total_count
number
required