Skip to main content
GET
/
v1
/
categories
Python
import os
from channel3_sdk import Channel3

client = Channel3(
    api_key=os.environ.get("CHANNEL3_API_KEY"),  # This is the default and can be omitted
)
page = client.categories.list()
page = page.items[0]
print(page.has_children)
{
  "items": [
    {
      "slug": "<string>",
      "title": "<string>",
      "has_children": true,
      "path": [
        {
          "slug": "<string>",
          "title": "<string>"
        }
      ]
    }
  ],
  "page": 123,
  "page_size": 123,
  "total": 123
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
roots_only
boolean
default:false

If true, return only top-level (root) categories.

​
page
integer
default:1

1-indexed page number.

Required range: x >= 1
​
page_size
integer
default:20

Items per page.

Required range: 1 <= x <= 100

Response

Successful Response

​
items
CategorySummary · object[]
required

Categories in this page

​
page
integer
required

1-indexed page number returned

​
page_size
integer
required

Number of items per page

​
total
integer
required

Total number of categories matching the query