Get collections

Lists collections (minimal fields) with pagination.

GET/api/v2/{team_slug}/{app_slug}/collections

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

management-api:GET:/api/v2/{team_slug}/{app_slug}/collections

Lists collections (minimal fields) with pagination.

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/v2/\{team_slug\}/\{app_slug\}/collections
Summary: Get collections
Description: Lists collections (minimal fields) with pagination.
OpenAPI contract: management-api
Operation ID: getCollections

Parameters7 parameters

Name	In	Required	Type	Description
Not documented in the OpenAPI contract.	Not documented in the OpenAPI contract.	No	any	Not documented in the OpenAPI contract.
Not documented in the OpenAPI contract.	Not documented in the OpenAPI contract.	No	any	Not documented in the OpenAPI contract.
page	query	No	integer	Not documented in the OpenAPI contract.
per-page	query	No	integer	Not documented in the OpenAPI contract.
search	query	No	string	Not documented in the OpenAPI contract.
collection-ids	query	No	string	Comma-separated collection ids
collection-id	query	No	string[]	Repeatable collection id

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses5 statuses

Status	Description	Content
200	OK	application/json (object)
400	Request-level failure	application/json (object)
401	Request-level failure	application/json (object)
403	Request-level failure	application/json (object)
500	Request-level failure	application/json (object)

200 - object

Collections List

Property	Type	Required	Details
`data`	object[]	Yes	-
`total_pages`	integer	Yes	-
`total_items`	integer	Yes	-

Collection Base

Property	Type	Required	Details
`id`	string (uuid)	Yes	format: uuid
`title`	string	Yes	-
`slug`	string	Yes	-
`status`	string	Yes	-
`parent_id`	string	No	-
`created_at`	string (date-time)	Yes	format: date-time
`updated_at`	string (date-time)	No	format: date-time
`uri`	string	Yes	-

Generated example (synthetic):

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "slug": "string",
      "status": "string",
      "parent_id": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "uri": "string"
    }
  ],
  "total_pages": 0,
  "total_items": 0
}

400 - object

Error

Property	Type	Required	Details
`error`	object	Yes	-

Error Body

Property	Type	Required	Details
`message`	string	Yes	-
`details`	string[]	Yes	-

Generated example (synthetic):

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

401 - object

Error

Property	Type	Required	Details
`error`	object	Yes	-

Error Body

Property	Type	Required	Details
`message`	string	Yes	-
`details`	string[]	Yes	-

Generated example (synthetic):

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

403 - object

Error

Property	Type	Required	Details
`error`	object	Yes	-

Error Body

Property	Type	Required	Details
`message`	string	Yes	-
`details`	string[]	Yes	-

Generated example (synthetic):

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

500 - object

Error

Property	Type	Required	Details
`error`	object	Yes	-

Error Body

Property	Type	Required	Details
`message`	string	Yes	-
`details`	string[]	Yes	-

Generated example (synthetic):

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

Contract identity

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

API family: Management API
Method: GET
Path: /api/v2/\{team_slug\}/\{app_slug\}/collections
Operation ID: getCollections
OpenAPI tag: Collections V2
OpenAPI summary: Get collections