Skip to main content
GET
/
v1
/
categories
/
search
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
)
search_categories_response = client.categories.search(
    query="x",
)
print(search_categories_response.categories)
{
  "categories": [
    {
      "slug": "<string>",
      "title": "<string>",
      "has_children": true,
      "path": [
        {
          "slug": "<string>",
          "title": "<string>"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.trychannel3.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
query
string
required

Free-text query (e.g. 'sofas', 'yoga mats').

Required string length: 1 - 200
​
limit
integer
default:5

Maximum number of categories to return.

Required range: 1 <= x <= 20

Response

Successful Response

​
categories
CategorySummary · object[]
required

Categories matching the query, ordered by relevance.