Company Collections index
Token-authenticated; returns every Collection regardless of
lifecycle (admins manage drafts / scheduled / archived rows).
Accepts the same params as the public catalog, plus the admin
filters filter[status] and filter[active].
Authorizations
Bearer token authentication. Accepts company-admin tokens with
storefront.view for read operations and storefront.update
for writes and scan triggers (legacy per-resource grants like
categories.update / products.view / etc. are still accepted
during the migration), required on every company operation.
Storefront public operations under /api/v202604/{resource} and
/api/v202604/{resource}/{slug} are unauthenticated
(security: []).
Query Parameters
Response locale. ISO code (e.g. fr, de). When omitted,
responds in the company's default locale. On the public
surface, falls back to en for any translated field missing
in the requested locale.
"fr"
Free-text search. Backed by Searchkick / Elasticsearch over
translation-aware title and description fields.
Rotulus cursor returned in meta.pagination.next_cursor (or
prev_cursor). Omit on the first page.
Page size. Default 25. Max 100. Requests above 100 return 422.
1 <= x <= 100ISO-2 country code. Restricts the catalog to resources available
in that country — combining the with_country_iso scope's
OR-empty semantics: unrestricted resources (no access_countries
rows) match every country.
"GB"
ISO locale. Restricts the catalog to resources translated in that locale.
"fr"
One of draft, scheduled, published, or archived. Restricts the
index to a single lifecycle state. Company-surface only. Matches the
STORED status column, not the read-time-resolved status: a past-due
scheduled row (its publish_at has passed, so it renders as
published) is matched by filter[status]=scheduled, NOT by
filter[status]=published.
draft, scheduled, published, archived Company-surface only. "true" / "false" restrict to active /
inactive rows; a blank value (filter[active]=) means "no
filter" — it is NOT where(active: nil).
, true, false Single sort key. Prefix with - for descending. Default
-created_at. These resources have no manual position, so
the position sort key is not offered.
title, -title, created_at, -created_at Response
A page of collections (every lifecycle state).
Shared success envelope for list / show / create / update
responses: the resource payload is returned alongside a top-level
integer status and meta. Composed onto each resource response
via allOf.