Skip to main content
GET
Company Products index

Authorizations

Authorization
string
header
required

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

lang
string

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.

Example:

"fr"

country
string

ISO-2 country code that selects COUNTRY-RELATIVE Product pricing. Product-only — Categories and other storefront resources use filter[country] as an access-list visibility filter instead.

For Products, country drives the pricing block and each variant's variant_countries: it picks which per-country variant price and currency are rendered. On the catalog it also drops products with no active variant in the requested country. When omitted, falls back to the company's default country.

Example:

"GB"

q
string

Free-text search. Backed by Searchkick / Elasticsearch over translation-aware title and description fields.

page[cursor]
string

Rotulus cursor returned in meta.pagination.next_cursor (or prev_cursor). Omit on the first page.

page[limit]
integer
default:25

Page size. Default 25. Max 100. Requests above 100 return 422.

Required range: 1 <= x <= 100
filter[status]
enum<string>

Raw Product enum key.

Available options:
active,
draft,
archived
filter[availability]
enum<string>
default:all

Stock filter. in_stock restricts to purchasable products; all (default) imposes no stock constraint.

Available options:
all,
in_stock
filter[bundle]
boolean

true returns only bundle products; false returns only non-bundle products.

filter[category_ids]
integer[]

Restrict to products in any of these category ids.

filter[collection_ids]
integer[]

Restrict to products in any of these collection ids.

sort
enum<string>

Single sort key. Prefix with - for descending. Default priority then id.

Available options:
priority,
-priority,
title,
-title,
created_at,
-created_at

Response

A page of products.

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.

status
integer
required
Example:

200

meta
object
required

Response metadata included on every successful response body. request_id and timestamp are always present; list endpoints also add pagination.

products
object[]
required