Skip to main content
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.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

timerIdstringrequired

Countdown Timer ID

Example:60d5f484f0f3c2001f2d5e4a

Query Parameters

contactIdstring

Contact ID for dynamic timer personalisation

Example:abc123contactId

Response

Timer retrieved

idstringrequired

Timer ID

Example:60d5f484f0f3c2001f2d5e4a
namestringrequired

Timer name

Example:Flash Sale Timer
templateIdstring

Template ID

Example:minimal
locationIdstringrequired

Location ID

Example:X9COWUStXtcLXTgBdqhm
statusstringrequired

Timer status

Available optionsactivedraftarchived
Example:draft
timerTypestringrequired

Timer type

Available optionsfixeddynamicrecurring
Example:fixed
endDatestring

End date (ISO 8601)

Example:2026-04-01T00:00:00.000Z
startDatestring

Start date (ISO 8601)

Example:2026-03-20T00:00:00.000Z
timezonestring

Timezone

Example:America/New_York
designMetaobject

Design metadata for timer appearance

timerDurationobject

Timer duration

linksobject

Timer links

trackingLinkstring

Tracking link URL

Example:https://t.example.com/abc123
hasLinkboolean

Whether timer has an active link

Example:true
previewUrlstring

Preview image URL

Example:https://storage.googleapis.com/cdn/countdown-timer/preview/abc123.gif
thumbnailUrlstring

Thumbnail image URL

Example:https://storage.googleapis.com/cdn/countdown-timer/thumbnail/abc123.png
expiryImageLinkstring

Expiry image link

Example:https://example.com/expiry.png
loopCountnumber

Number of recurring loops

Example:3
waitTimeobject

Wait time between loops

hideTimerForAppleMailboolean

Hide timer for Apple Mail clients

Example:false
hideRecurringTimerFunnelsboolean

Hide recurring timer in funnels

Example:false
dynamicTimerParamsobject

Dynamic timer parameters

createdAtstring

Created timestamp

Example:2026-03-20T12:00:00.000Z
updatedAtstring

Updated timestamp

Example:2026-03-20T12:00:00.000Z