Skip to main content
GET
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
categories
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "attributes": [
        {
          "created_at": "<string>",
          "description": "<string>",
          "filterable": true,
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "template_key": "<string>",
          "template_name": "<string>",
          "translatable": true,
          "translations": {
            "description": [
              {
                "id": "<string>",
                "locale": "<string>",
                "value": "<string>"
              }
            ],
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>",
          "values": {}
        }
      ],
      "children": "<array>",
      "cover_url": "<string>",
      "created_at": "<string>",
      "google_product_category_id": "<string>",
      "id": "<string>",
      "name": "<string>",
      "parent_id": "<string>",
      "redirects": [
        {
          "id": "<string>",
          "item_id": "<string>",
          "locale": "<string>",
          "new_slug": "<string>",
          "old_slug": "<string>"
        }
      ],
      "slug": "<string>",
      "sort_order": 123,
      "status": "<string>",
      "translations": {
        "name": [
          {
            "id": "<string>",
            "locale": "<string>",
            "value": "<string>"
          }
        ],
        "slug": [
          {
            "id": "<string>",
            "locale": "<string>",
            "value": "<string>"
          }
        ]
      },
      "updated_at": "<string>",
      "uri": "<string>"
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Query Parameters

​
search
string

Search on category name

​
page
integer

Page number (default is 1)

​
per-page
integer

Amount of products per page. Minimum 0 and max 100 (default is 20)

​
sort-order
string

Sort order. Should be one of ASC or DESC. Default DESC

​
sort-key
string

The key to sort on. Can be one of name, sort_order, created-at, updated-at (Default is created-at)

​
id
string[]

Filter by category IDs (can be repeated)

Response

Categories list

​
data
object[]
​
success
boolean
​
total
integer
​
total_pages
integer