Skip to main content
GET
Get a collection

Authorizations

Authorization
string
header
required

An app access token from POST /apps/oauth/token, valid 1 hour. An offline token acts as the app; an online token acts as the app on behalf of one dashboard user (the intersection of both permission sets).

Path Parameters

id
string
required

A resource id. One this installation cannot read, or a malformed one, is 404 NOT_FOUND.

Minimum string length: 1

Query Parameters

fields
string

Return only these top-level fields, separated by commas; the id is always kept. The response schema describes the whole resource. An unknown name is 400 INVALID_FIELDS. Fields: id, storeId, parentId, name, description, image, active, sortOrder, productSort, ruleMatch, rules, productsCount, createdAt, updatedAt.

Maximum string length: 1000

Response

The collection.

data
object
required

A collection (API 2026-10).