# List Countdown Timers GET https://services.leadconnectorhq.com/countdown-timer/timers Get a paginated list of the countdown timers belonging to the access token's location ## Authentication Send `Authorization: Bearer ` using: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `countdown-timer/timer.readonly` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `limit` | number | No | Maximum number of timers to return | | `skip` | number | No | Number of timers to skip for pagination | | `type` | string | No | Filter by timer type | | `status` | string | No | Filter by timer status | | `name` | string | No | Search by timer name | | `isExpired` | string | No | Filter by expired state | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "HighLevel API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/countdown-timer/timers": { "get": { "summary": "List Countdown Timers", "operationId": "listCountdownTimers", "description": "Get a paginated list of the countdown timers belonging to the access token's location", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "Maximum number of timers to return", "schema": { "default": 10, "example": 10, "type": "number" } }, { "name": "skip", "required": false, "in": "query", "description": "Number of timers to skip for pagination", "schema": { "default": 0, "example": 0, "type": "number" } }, { "name": "type", "required": false, "in": "query", "description": "Filter by timer type", "schema": { "example": "all", "enum": [ "fixed", "dynamic", "recurring", "all" ], "type": "string" } }, { "name": "status", "required": false, "in": "query", "description": "Filter by timer status", "schema": { "example": "draft", "enum": [ "active", "draft", "archived", "all", "active_draft" ], "type": "string" } }, { "name": "name", "required": false, "in": "query", "description": "Search by timer name", "schema": { "maxLength": 100, "example": "Flash Sale", "type": "string" } }, { "name": "isExpired", "required": false, "in": "query", "description": "Filter by expired state", "schema": { "example": "false", "enum": [ "true", "false" ], "type": "string" } }, { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } } ], "responses": { "200": { "description": "Timer list retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCountdownTimersPublicV1ResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "403": { "description": "The token does not have access to this location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvalidLocationDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } } }, "security": [ { "Location-Access": [ "countdown-timer/timer.readonly" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "ListCountdownTimersPublicV1ResponseDto": { "type": "object", "properties": { "countdownTimers": { "description": "List of countdown timers", "example": [ { "id": "60d5f484f0f3c2001f2d5e4a", "name": "Flash Sale Timer", "timerType": "fixed", "status": "draft", "locationId": "X9COWUStXtcLXTgBdqhm" } ], "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Timer ID", "example": "60d5f484f0f3c2001f2d5e4a" }, "name": { "type": "string", "description": "Timer name", "example": "Flash Sale Timer" }, "templateId": { "type": "string", "description": "Template ID", "example": "minimal" }, "locationId": { "type": "string", "description": "Location ID", "example": "X9COWUStXtcLXTgBdqhm" }, "status": { "type": "string", "description": "Timer status", "enum": [ "active", "draft", "archived" ], "example": "draft" }, "timerType": { "type": "string", "description": "Timer type", "enum": [ "fixed", "dynamic", "recurring" ], "example": "fixed" }, "endDate": { "type": "string", "description": "End date (ISO 8601)", "example": "2026-04-01T00:00:00.000Z" }, "startDate": { "type": "string", "description": "Start date (ISO 8601)", "example": "2026-03-20T00:00:00.000Z" }, "timezone": { "type": "string", "description": "Timezone", "example": "America/New_York" }, "designMeta": { "description": "Design metadata for timer appearance", "example": { "digitColor": "#a21043", "labelColor": "#a21043", "backgroundColor": "#ffffff", "counterFontSize": 50 }, "allOf": [ { "type": "object", "properties": { "counterFontSize": { "type": "number", "description": "Counter font size in px", "example": 50 }, "counterFontFamily": { "type": "string", "description": "Counter font family", "example": "inter" }, "counterFontWeight": { "type": "string", "description": "Counter font weight", "example": "normal" }, "labelFontSize": { "type": "number", "description": "Label font size in px", "example": 15 }, "labelFontFamily": { "type": "string", "description": "Label font family", "example": "inter" }, "labelFontWeight": { "type": "string", "description": "Label font weight", "example": "normal" }, "digitColor": { "type": "string", "description": "Digit color (hex)", "example": "#a21043" }, "labelColor": { "type": "string", "description": "Label color (hex)", "example": "#a21043" }, "separatorColor": { "type": "string", "description": "Separator color (hex)", "example": "#feccd6" }, "backgroundColor": { "type": "string", "description": "Background color (hex)", "example": "#ffffff" }, "circleBorderColor": { "type": "string", "description": "Circle border color (hex)", "example": "#000000" }, "circleFillColor": { "type": "string", "description": "Circle fill color (hex)", "example": "#ffffff" }, "boxColor": { "type": "string", "description": "Box color (hex)", "example": "#101828" }, "borderColor": { "type": "string", "description": "Border color (hex)", "example": "#101828" }, "isTransparent": { "type": "boolean", "description": "Transparent background", "example": false }, "hasSeparator": { "type": "boolean", "description": "Show separator between units", "example": true }, "hasFillingBorder": { "type": "boolean", "description": "Show filling border animation", "example": false }, "hasBoxColor": { "type": "boolean", "description": "Show box color behind digits", "example": false }, "labels": { "description": "Unit labels", "example": { "days": "Days", "hours": "Hours", "minutes": "Minutes", "seconds": "Seconds" }, "allOf": [ { "type": "object", "properties": { "days": { "type": "string", "description": "Label for days unit", "example": "Days" }, "hours": { "type": "string", "description": "Label for hours unit", "example": "Hours" }, "minutes": { "type": "string", "description": "Label for minutes unit", "example": "Minutes" }, "seconds": { "type": "string", "description": "Label for seconds unit", "example": "Seconds" } }, "title": "DesignLabelsDto" } ] }, "unitVisibility": { "description": "Unit visibility toggles", "example": { "days": true, "hours": true, "minutes": true, "seconds": true }, "allOf": [ { "type": "object", "properties": { "days": { "type": "boolean", "description": "Show days", "example": true }, "hours": { "type": "boolean", "description": "Show hours", "example": true }, "minutes": { "type": "boolean", "description": "Show minutes", "example": true }, "seconds": { "type": "boolean", "description": "Show seconds", "example": true } }, "title": "UnitVisibilityDto" } ] }, "borderRadius": { "type": "number", "description": "Border radius in px", "example": 12 }, "hasPadding": { "type": "boolean", "description": "Enable padding", "example": true }, "padding": { "description": "Padding values", "example": { "top": 16, "bottom": 16, "left": 16, "right": 16 }, "allOf": [ { "type": "object", "properties": { "top": { "type": "number", "description": "Top padding in px", "example": 16 }, "bottom": { "type": "number", "description": "Bottom padding in px", "example": 16 }, "left": { "type": "number", "description": "Left padding in px", "example": 16 }, "right": { "type": "number", "description": "Right padding in px", "example": 16 } }, "title": "PaddingDto" } ] }, "previewUrl": { "type": "string", "description": "Preview image URL from template", "example": "https://storage.googleapis.com/cdn/countdown-timer/templates/minimal/preview.png" } }, "title": "DesignMetaApiDto" } ] }, "timerDuration": { "type": "object", "description": "Timer duration", "example": { "days": 1, "hours": 2, "minutes": 0, "seconds": 0 } }, "links": { "type": "object", "description": "Timer links", "example": { "activeLink": "https://example.com", "expiryLink": "https://example.com/expired" } }, "trackingLink": { "type": "string", "description": "Tracking link URL", "example": "https://t.example.com/abc123" }, "hasLink": { "type": "boolean", "description": "Whether timer has an active link", "example": true }, "previewUrl": { "type": "string", "description": "Preview image URL", "example": "https://storage.googleapis.com/cdn/countdown-timer/preview/abc123.gif" }, "thumbnailUrl": { "type": "string", "description": "Thumbnail image URL", "example": "https://storage.googleapis.com/cdn/countdown-timer/thumbnail/abc123.png" }, "expiryImageLink": { "type": "string", "description": "Expiry image link", "example": "https://example.com/expiry.png" }, "loopCount": { "type": "number", "description": "Number of recurring loops", "example": 3 }, "waitTime": { "type": "object", "description": "Wait time between loops", "example": { "minutes": 30 } }, "hideTimerForAppleMail": { "type": "boolean", "description": "Hide timer for Apple Mail clients", "example": false }, "hideRecurringTimerFunnels": { "type": "boolean", "description": "Hide recurring timer in funnels", "example": false }, "dynamicTimerParams": { "type": "object", "description": "Dynamic timer parameters", "example": { "endTime": "17:00", "trigger": "sent" } }, "createdAt": { "type": "string", "description": "Created timestamp", "example": "2026-03-20T12:00:00.000Z" }, "updatedAt": { "type": "string", "description": "Updated timestamp", "example": "2026-03-20T12:00:00.000Z" } }, "required": [ "id", "name", "locationId", "status", "timerType" ], "title": "CountdownTimerResponseDto" } }, "total": { "type": "number", "description": "Total count of matching timers", "example": 25 } }, "required": [ "countdownTimers", "total" ], "title": "ListCountdownTimersPublicV1ResponseDto" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "InvalidLocationDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "description": "HTTP status code for invalid location access", "example": 403 }, "message": { "type": "string", "description": "Error message describing the location access failure", "example": "The token does not have access to this location" } }, "title": "InvalidLocationDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/countdown-timer/timers' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' ``` **Node.js** ```javascript const options = { method: 'GET', headers: { Authorization: 'Bearer ', Version: 'v3' } }; try { const response = await fetch('https://services.leadconnectorhq.com/countdown-timer/timers', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/countdown-timer/timers" headers = { "Authorization": "Bearer ", "Version": "v3" } response = requests.get(url, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/countdown-timer/timers', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', ], ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .get("https://services.leadconnectorhq.com/countdown-timer/timers") .header("Authorization", "Bearer ") .header("Version", "v3") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/countdown-timer/timers" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/countdown-timer/timers") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/countdown-timer/timers' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```