Skip to main content
GET
/
v2
/
schedules
/
{id}
{
  "id": "6651a3f2e4b0a1c2d3e4f567",
  "name": "Weekend Promo Blast",
  "status": "on",
  "send_type": "blast",
  "source_lists": [101, 204],
  "audiences": ["665fa1b2c3d4e5f6a7b8c901"],
  "is_repeating": true,
  "send_time": "14:30",
  "send_date": null,
  "start_date": "2025-06-01T00:00:00Z",
  "end_date": "2025-08-31T00:00:00Z",
  "days_of_week": {
    "monday": false,
    "tuesday": false,
    "wednesday": false,
    "thursday": false,
    "friday": true,
    "saturday": true,
    "sunday": true
  },
  "skip_within_hours": 24,
  "use_local_time": true,
  "filter_bots": true,
  "is_mms": false,
  "is_cto": false,
  "automated_percent": 0,
  "ir_revenue": 2.50,
  "blasts": [
    {
      "message": "Flash sale this weekend! Shop now: {{link1}}",
      "offer_links": [
        {
          "key": "link1",
          "offer_id": "offer_abc123",
          "url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
        }
      ],
      "percent_audience": 60,
      "variant_name": "Control",
      "mms_image_url": null
    },
    {
      "message": "Don't miss out — 20% off everything: {{link1}}",
      "offer_links": [
        {
          "key": "link1",
          "offer_id": "offer_abc123",
          "url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
        }
      ],
      "percent_audience": 40,
      "variant_name": "Urgency Variant",
      "mms_image_url": null
    }
  ],
  "created_at": "2025-05-28T10:15:30Z",
  "updated_at": "2025-06-01T08:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.tracklysms.com/llms.txt

Use this file to discover all available pages before exploring further.

Fetch the full details of a specific schedule by providing its unique identifier. Returns the complete schedule object including all configuration, blast variants, and timestamps.

​
Path Parameters

​
id
string
required
The unique identifier of the schedule to retrieve.

​
Response Fields

​
id
string
Unique identifier for the schedule.
​
name
string
Name of the schedule.
​
status
string
Current status. One of: draft, off, on, complete, archive.
​
send_type
string
Type of schedule. One of: blast or automated.
​
source_lists
array of integers
IDs of the source sending lists assigned to this schedule.
​
audiences
array of strings
IDs of the audiences targeted by this schedule.
​
is_repeating
boolean
Whether this schedule repeats on selected days of the week.
​
send_time
string
Time of day to send, in HH:MM format (24-hour).
​
send_date
datetime
The specific date for a one-time (non-repeating) schedule.
​
start_date
datetime
Start date for a repeating schedule.
​
end_date
datetime
End date for a repeating schedule.
​
days_of_week
object
Which days the repeating schedule is active. Contains boolean fields: monday, tuesday, wednesday, thursday, friday, saturday, sunday.
​
skip_within_hours
float
Skip sending to a contact if they were already sent to within this many hours.
​
use_local_time
boolean
Whether send_time is interpreted in each recipient’s local timezone.
​
filter_bots
boolean
Whether bot filtering is enabled for this schedule.
​
is_mms
boolean
Whether this schedule sends MMS messages.
​
is_cto
boolean
Whether click-to-open mode is enabled.
​
automated_percent
float
Percentage of the audience allocated to automated creative selection.
​
ir_revenue
float
Expected revenue per conversion.
​
blasts
array
Array of blast variant objects.
​
created_at
datetime
Timestamp when the schedule was created.
​
updated_at
datetime
Timestamp when the schedule was last updated.

​
Examples

cURL
curl -X GET "https://api.tracklysms.com/api/v2/schedules/6651a3f2e4b0a1c2d3e4f567" \
  -H "X-Api-Key: trk_your_api_key_here"
Python
import requests

schedule_id = "6651a3f2e4b0a1c2d3e4f567"

response = requests.get(
    f"https://api.tracklysms.com/api/v2/schedules/{schedule_id}",
    headers={"X-Api-Key": "trk_your_api_key_here"},
)

schedule = response.json()
print(f"{schedule['name']} — {schedule['status']}")
Node.js
const scheduleId = "6651a3f2e4b0a1c2d3e4f567";

const response = await fetch(
  `https://api.tracklysms.com/api/v2/schedules/${scheduleId}`,
  {
    method: "GET",
    headers: {
      "X-Api-Key": "trk_your_api_key_here"
    }
  }
);

const schedule = await response.json();
console.log(`${schedule.name} — ${schedule.status}`);

{
  "id": "6651a3f2e4b0a1c2d3e4f567",
  "name": "Weekend Promo Blast",
  "status": "on",
  "send_type": "blast",
  "source_lists": [101, 204],
  "audiences": ["665fa1b2c3d4e5f6a7b8c901"],
  "is_repeating": true,
  "send_time": "14:30",
  "send_date": null,
  "start_date": "2025-06-01T00:00:00Z",
  "end_date": "2025-08-31T00:00:00Z",
  "days_of_week": {
    "monday": false,
    "tuesday": false,
    "wednesday": false,
    "thursday": false,
    "friday": true,
    "saturday": true,
    "sunday": true
  },
  "skip_within_hours": 24,
  "use_local_time": true,
  "filter_bots": true,
  "is_mms": false,
  "is_cto": false,
  "automated_percent": 0,
  "ir_revenue": 2.50,
  "blasts": [
    {
      "message": "Flash sale this weekend! Shop now: {{link1}}",
      "offer_links": [
        {
          "key": "link1",
          "offer_id": "offer_abc123",
          "url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
        }
      ],
      "percent_audience": 60,
      "variant_name": "Control",
      "mms_image_url": null
    },
    {
      "message": "Don't miss out — 20% off everything: {{link1}}",
      "offer_links": [
        {
          "key": "link1",
          "offer_id": "offer_abc123",
          "url_params": {"utm_source": "sms", "utm_campaign": "weekend"}
        }
      ],
      "percent_audience": 40,
      "variant_name": "Urgency Variant",
      "mms_image_url": null
    }
  ],
  "created_at": "2025-05-28T10:15:30Z",
  "updated_at": "2025-06-01T08:00:00Z"
}

​
Error Codes

HTTP StatusError CodeDescription
401unauthorizedAPI key is missing, invalid, or revoked.
404not_foundNo schedule exists with the given ID.

​
Next Steps

Campaign Scheduling

Scheduling best practices

List Audiences

View audiences