Get Countdown Timer

GET 
/countdown-timer/timers/:timerId

Get a countdown timer by ID

Request

Version stringrequired

API Version

Available optionsv3

timerId stringrequired

Countdown Timer ID

contactId string

Contact ID for dynamic timer personalisation

application/json

Timer retrieved

application/json

Schema

Schema

idstringrequired

Timer ID

namestringrequired

Timer name

templateIdstring

Template ID

locationIdstringrequired

Location ID

statusstringrequired
Timer status
Available optionsactivedraftarchived
timerTypestringrequired
Timer type
Available optionsfixeddynamicrecurring
endDatestring

End date (ISO 8601)

startDatestring

Start date (ISO 8601)

timezonestring

Timezone

designMetaobject

Design metadata for timer appearance

timerDurationobject

Timer duration

linksobject

Timer links

trackingLinkstring

Tracking link URL

hasLinkboolean

Whether timer has an active link

previewUrlstring

Preview image URL

thumbnailUrlstring

Thumbnail image URL

expiryImageLinkstring

Expiry image link

loopCountnumber

Number of recurring loops

waitTimeobject

Wait time between loops

hideTimerForAppleMailboolean

Hide timer for Apple Mail clients

hideRecurringTimerFunnelsboolean

Hide recurring timer in funnels

dynamicTimerParamsobject

Dynamic timer parameters

createdAtstring

Created timestamp

updatedAtstring

Updated timestamp

Example (auto)

{
  "id": "60d5f484f0f3c2001f2d5e4a",
  "name": "Flash Sale Timer",
  "templateId": "minimal",
  "locationId": "X9COWUStXtcLXTgBdqhm",
  "status": "draft",
  "timerType": "fixed",
  "endDate": "2026-04-01T00:00:00.000Z",
  "startDate": "2026-03-20T00:00:00.000Z",
  "timezone": "America/New_York",
  "designMeta": {
    "digitColor": "#a21043",
    "labelColor": "#a21043",
    "backgroundColor": "#ffffff",
    "counterFontSize": 50
  },
  "timerDuration": {
    "days": 1,
    "hours": 2,
    "minutes": 0,
    "seconds": 0
  },
  "links": {
    "activeLink": "https://example.com",
    "expiryLink": "https://example.com/expired"
  },
  "trackingLink": "https://t.example.com/abc123",
  "hasLink": true,
  "previewUrl": "https://storage.googleapis.com/cdn/countdown-timer/preview/abc123.gif",
  "thumbnailUrl": "https://storage.googleapis.com/cdn/countdown-timer/thumbnail/abc123.png",
  "expiryImageLink": "https://example.com/expiry.png",
  "loopCount": 3,
  "waitTime": {
    "minutes": 30
  },
  "hideTimerForAppleMail": false,
  "hideRecurringTimerFunnels": false,
  "dynamicTimerParams": {
    "endTime": "17:00",
    "trigger": "sent"
  },
  "createdAt": "2026-03-20T12:00:00.000Z",
  "updatedAt": "2026-03-20T12:00:00.000Z"
}