Skip to main content
cURL
Cost: Free.
A category matches when every word of q is in its name or its path (the names above it), in any letter case, also inside a longer word. Without q, you get the top-level categories.
Best matches first: the name is exactly q, then it starts with q, then it contains q, then it holds every word, then the rest. Within each group, shallower categories come first, then by name.
Pass a category’s id as category_id to Search products: it covers every category under it too. For a category’s parent and subcategories, use Get category.

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Query Parameters

q
string

Words to find, for example mugs or kitchen mugs. A category matches when every word appears, in any letter case and also inside a longer word, in its name or in its path (the names above it). Without it, the top-level categories are listed.

Required string length: 1 - 100
Example:

"mugs"

limit
integer

Page size: default 25, at most 100.

Required range: 1 <= x <= 100
cursor
string

The next_cursor of the previous page. Bound to the query, the workspace and the key.

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "list"
data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
total
object
required