Categories

List categories

Changed on

Returns a paginated list of your categories. Nesting is expressed by parentId; for the assembled hierarchy use GET /v1/taxonomies/categories/tree.

get/taxonomies/categories

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/taxonomies/categories
  • Auth: HTTP bearer

Query parameters

cursorstring
limitinteger
searchstring

Full-text search over the taxonomy name (matches name tokens, not slug).

parentIdstring

Filter to the direct children of a parent category id. The literal "null" is a deprecated alias for topLevel=true. Combined with search, a page may be short or empty while hasMore is true: keep paging until hasMore is false.

topLevel'true' | 'false'

When true, return only top-level categories (those with no parent). Cannot be combined with a parentId category id.

Response

Successful response.

object'list' required
urlstring required
hasMoreboolean required
nextCursorstring nullable required

Example response

{
  "url": "/v1/taxonomies/categories"
}

Changes