Skip to main content
GET
List playlists (company, authenticated)

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"

page[cursor]
string

Opaque Rotulus cursor from the previous response's meta.pagination.next_cursor.

page[limit]
integer
default:25

Page size. Default 25, max 100; a larger value returns 422.

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

One of draft, scheduled, or published. 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.

Available options:
draft,
scheduled,
published
filter[active]
enum<string>

Company-surface only. "true" / "false" restrict to active / inactive rows; a blank value (filter[active]=) means "no filter" — it is NOT where(active: nil).

Available options:
,
true,
false
filter[country]
string

ISO-2 country code. Returns unrestricted playlists plus those restricted to this country.

filter[language]
string

ISO locale. Restricts to playlists translated in this locale.

sort
enum<string>

Sort axis. Prefix - for descending. Default is -created_at.

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

Response

Paginated list of company playlists.

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.

playlists
object[]
required