Get Category Tree

Retrieves the hierarchical category tree structure for an app with parent-child relationships and optional sorting

GET/api/v1/{team_slug}/{app_slug}/categories/tree

API: Management
OpenAPI: management-api
Updated: Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/categories/tree

Retrieves the hierarchical category tree structure for an app with parent-child relationships and optional sorting

API ownership

API family: Management API
Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
Do not use from: Browser-only storefront code or public clients.
Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: GET
Path: /api/v1/\{team_slug\}/\{app_slug\}/categories/tree
Summary: Get Category Tree
Description: Retrieves the hierarchical category tree structure for an app with parent-child relationships and optional sorting
OpenAPI contract: management-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters4 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug
sort-order	query	No	string	Sort order. Should be one of ASC or DESC. Default DESC
sort-key	query	No	string	The key to sort on. Can be one of `name`, `sort_order`, `created_at`, `updated_at` (Default is `created-at`)

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses

Status	Description	Content
200	Categories tree	application/json (object)
400	Invalid request (e.g. bad UUID, validation error)	application/json (object)
401	Unauthorized access	application/json (object)
500	Internal server error	application/json (object)

200 - object

Property	Type	Required	Details
`data`	object[]	No	-
`success`	boolean	No	-
`total`	integer	No	-
`total_pages`	integer	No	-

Property	Type	Required	Details
`attributes`	object[]	No	-
`children`	object[]	No	-
`cover_url`	string	No	-
`created_at`	string	No	-
`google_product_category_id`	string	No	-
`id`	string	No	-
`name`	string	No	-
`parent_id`	string	No	-
`redirects`	object[]	No	-
`slug`	string	No	-
`sort_order`	integer	No	Used for ordering categories themselves
`status`	string	No	-
`translations`	object	No	-
`updated_at`	string	No	-
`uri`	string	No	-

Attribute

Property	Type	Required	Details
`created_at`	string	No	-
`description`	string	No	-
`filterable`	boolean	No	-
`id`	string	No	-
`key`	string	No	-
`name`	string	No	-
`template_key`	string	No	-
`template_name`	string	No	-
`translatable`	boolean	No	-
`translations`	object	No	-
`updated_at`	string	No	-
`values`	object	No	-

Redirects

Property	Type	Required	Details
`id`	string	No	-
`item_id`	string	No	-
`locale`	string	No	-
`new_slug`	string	No	-
`old_slug`	string	No	-
`type`	enum("product", "page", "collection", "category", "product_bundle")	No	-

Category Translations

Property	Type	Required	Details
`name`	object[]	No	-
`slug`	object[]	No	-

{
  "data": [
    {
      "attributes": [
        {
          "created_at": null,
          "description": null,
          "filterable": null,
          "id": null,
          "key": null,
          "name": null,
          "template_key": null,
          "template_name": null,
          "translatable": null,
          "translations": null,
          "updated_at": null,
          "values": null
        }
      ],
      "children": [
        {
          "attributes": null,
          "children": null,
          "cover_url": null,
          "created_at": null,
          "google_product_category_id": null,
          "id": null,
          "name": null,
          "parent_id": null,
          "redirects": null,
          "slug": null,
          "sort_order": null,
          "status": null,
          "translations": null,
          "updated_at": null,
          "uri": null
        }
      ],
      "cover_url": "string",
      "created_at": "string",
      "google_product_category_id": "string",
      "id": "string",
      "name": "string",
      "parent_id": "string",
      "redirects": [
        {
          "id": null,
          "item_id": null,
          "locale": null,
          "new_slug": null,
          "old_slug": null,
          "type": null
        }
      ],
      "slug": "string",
      "sort_order": 0,
      "status": "string",
      "translations": {
        "name": [],
        "slug": []
      },
      "updated_at": "string",
      "uri": "string"
    }
  ],
  "success": false,
  "total": 0,
  "total_pages": 0
}

400 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

Property	Type	Required	Details
`details`	string[]	No	-
`message`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Management API
Method: GET
Path: /api/v1/\{team_slug\}/\{app_slug\}/categories/tree
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Categories
OpenAPI summary: Get Category Tree