List Countdown Timers

GET 
/countdown-timer/timers

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

Request

Version stringrequired

API Version

Available optionsv3

limit number

Maximum number of timers to return

Default value:10

skip number

Number of timers to skip for pagination

Default value:0

type string

Filter by timer type

Available optionsfixeddynamicrecurringall

status string

Filter by timer status

Available optionsactivedraftarchivedallactive_draft

name string

Search by timer name

Possible values: <= 100 characters

isExpired string

Filter by expired state

Available optionstruefalse

application/json

Timer list retrieved

application/json

Schema

Schema

countdownTimersobject[]required

List of countdown timers

totalnumberrequired

Total count of matching timers

Example (auto)

{
  "countdownTimers": [
    {
      "id": "60d5f484f0f3c2001f2d5e4a",
      "name": "Flash Sale Timer",
      "timerType": "fixed",
      "status": "draft",
      "locationId": "X9COWUStXtcLXTgBdqhm"
    }
  ],
  "total": 25
}