Countdown TimersVersion: v3New
Get Countdown Timer
GET/countdown-timer/timers/{timerId}
Get a countdown timer by ID
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
countdown-timer/ timer. readonlyAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Example:
v3Path Parameters
timerIdstringrequired
Countdown Timer ID
Example:
60d5f484f0f3c2001f2d5e4aQuery Parameters
contactIdstring
Contact ID for dynamic timer personalisation
Example:
abc123contactIdResponse
Timer retrieved
idstringrequired
Timer ID
Example:
60d5f484f0f3c2001f2d5e4anamestringrequired
Timer name
Example:
Flash Sale TimertemplateIdstring
Template ID
Example:
minimallocationIdstringrequired
Location ID
Example:
X9COWUStXtcLXTgBdqhmstatusstringrequired
Timer status
Available options
activedraftarchivedExample:
drafttimerTypestringrequired
Timer type
Available options
fixeddynamicrecurringExample:
fixedendDatestring
End date (ISO 8601)
Example:
2026-04-01T00:00:00.000ZstartDatestring
Start date (ISO 8601)
Example:
2026-03-20T00:00:00.000Ztimezonestring
Timezone
Example:
America/New_YorkdesignMetaobject
Design metadata for timer appearance
timerDurationobject
Timer duration
linksobject
Timer links
trackingLinkstring
Tracking link URL
Example:
https://t.example.com/abc123hasLinkboolean
Whether timer has an active link
Example:
truepreviewUrlstring
Preview image URL
Example:
https://storage.googleapis.com/cdn/countdown-timer/preview/abc123.gifthumbnailUrlstring
Thumbnail image URL
Example:
https://storage.googleapis.com/cdn/countdown-timer/thumbnail/abc123.pngexpiryImageLinkstring
Expiry image link
Example:
https://example.com/expiry.pngloopCountnumber
Number of recurring loops
Example:
3waitTimeobject
Wait time between loops
hideTimerForAppleMailboolean
Hide timer for Apple Mail clients
Example:
falsehideRecurringTimerFunnelsboolean
Hide recurring timer in funnels
Example:
falsedynamicTimerParamsobject
Dynamic timer parameters
createdAtstring
Created timestamp
Example:
2026-03-20T12:00:00.000ZupdatedAtstring
Updated timestamp
Example:
2026-03-20T12:00:00.000Z