PEpeec
Products

List Categories

List a project's product categories. Each row carries its full path and its parent_id, so the flat list reconstructs the category tree. Use the returned id as a category_id when creating, updating, or assigning products.

get/categories

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/categories
  • 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

Response

The project's categories as a flat tree

total_countnumber required

Example response

{
  "data": [
    {
      "id": "0190f9a1-1d8c-7e3a-9c2b-1f0a2b3c4d5e",
      "name": "Running Shoes",
      "path": "Footwear > Shoes > Running Shoes"
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.