Skip to main content
GET
List Promotions

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Query Parameters

organizationId
string

Optional organization scope for session-authenticated calls. OAuth client credentials resolve the organization from the token.

Maximum string length: 120
q
string

Search promotion name.

Maximum string length: 200
status
enum<string>

Effective status filter: all, draft, scheduled, active, paused, ended, or archived.

Available options:
all,
draft,
scheduled,
active,
paused,
ended,
archived
marketplace
string

Comma-separated marketplaces, for example shopee,lazada,tiktok,shopify.

Maximum string length: 200
store
string

Comma-separated promotion store keys (marketplace:country:storeId).

Maximum string length: 2000
sortBy
enum<string>
default:createdAt

Sort field.

Available options:
createdAt,
name,
startsAt,
status
sortDir
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
limit
integer
default:20

Page size. Default 20, max 50.

Required range: 1 <= x <= 50
offset
integer
default:0

Zero-based pagination offset.

Required range: x >= 0

Response

Promotions page returned.

items
object[]
required
summary
object
required
pagination
object
required
hasMore
boolean
nextOffset
integer