Get a collection by ID

Retrieves a collection with all translations, redirects, and its children (nested collections).

GET/api/v1/{team_slug}/{app_slug}/collections/{collection_id}

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

management-api:GET:/api/v1/{team_slug}/{app_slug}/collections/{collection_id}

Retrieves a collection with all translations, redirects, and its children (nested collections).

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\}/collections/\{collection_id\}
Summary: Get a collection by ID
Description: Retrieves a collection with all translations, redirects, and its children (nested collections).
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.

Parameters3 parameters

Name	In	Required	Type	Description
app_slug	path	Yes	string	App slug
team_slug	path	Yes	string	Team slug
collection_id	path	Yes	string	ID of collection

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses5 statuses

Status	Description	Content
200	Collection updated successfully	application/json (object)
400	Invalid request (e.g. bad UUID, validation error)	application/json (object)
401	Unauthorized access	application/json (object)
422	Invalid request and not parsable by backend	application/json (object)
500	Internal server error	application/json (object)

200 - object

Full Collection

Property	Type	Required	Details
`data`	object	No	-
`details`	string[]	No	Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
`success`	boolean	No	-

Collection

Property	Type	Required	Details
`children`	object[]	No	-
`created_at`	string	No	-
`id`	string	No	-
`parent_id`	string	No	-
`redirects`	object[]	No	-
`slug`	string	Yes	-
`status`	enum("active", "inactive", "draft")	Yes	-
`title`	string	No	-
`translations`	object	No	-
`updated_at`	string	No	-
`uri`	string	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	-

Collection Translation

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

{
  "data": {
    "children": [
      {
        "children": [],
        "created_at": "string",
        "id": "string",
        "parent_id": "string",
        "redirects": [],
        "slug": "string",
        "status": "active",
        "title": "string",
        "translations": {
          "slug": null,
          "title": null
        },
        "updated_at": "string",
        "uri": "string"
      }
    ],
    "created_at": "string",
    "id": "string",
    "parent_id": "string",
    "redirects": [
      {
        "id": "string",
        "item_id": "string",
        "locale": "string",
        "new_slug": "string",
        "old_slug": "string",
        "type": "product"
      }
    ],
    "slug": "string",
    "status": "active",
    "title": "string",
    "translations": {
      "slug": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ],
      "title": [
        {
          "id": null,
          "locale": null,
          "value": null
        }
      ]
    },
    "updated_at": "string",
    "uri": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

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
}

422 - 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\}/collections/\{collection_id\}
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Collections
OpenAPI summary: Get a collection by ID