Skip to main content
Countdown TimersVersion: v3New

List Countdown Timers

GET/countdown-timer/timers

Get a paginated list of the countdown timers belonging to the access token's location

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:countdown-timer/timer.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Query Parameters

limitnumber

Maximum number of timers to return

Default:10
Example:10
skipnumber

Number of timers to skip for pagination

Default:0
Example:0
typestring

Filter by timer type

Available optionsfixeddynamicrecurringall
Example:all
statusstring

Filter by timer status

Available optionsactivedraftarchivedallactive_draft
Example:draft
namestring

Search by timer name

Possible values: <= 100 characters

Example:Flash Sale
isExpiredstring

Filter by expired state

Available optionstruefalse
Example:false

Response

Timer list retrieved

countdownTimersobject[]required

List of countdown timers

totalnumberrequired

Total count of matching timers

Example:25