Skip to content

List sending schedules (send windows + timezone)

GET
/schedules

Return the org’s send-window schedules.

Each row carries id, name, timezone, and a flattened per-day windows list. Pass id back as schedule_id on POST /campaigns/{id}/launch or PATCH /sequences/{id} to attach the schedule before the scheduler starts queueing sends.

The underlying sequencer route is GET /schedules (unprefixed inside the sequencer app); this dev-API route is a thin org-scoped proxy that rewraps the rows into the launch-helper DTO shape and returns a {data: [...]} envelope for consistency with the rest of the dev API.

Authorizations

Parameters

Query Parameters

include_archived

Include archived schedules in the response. Default False matches the sequencer schedule picker.

boolean

Include archived schedules in the response. Default False matches the sequencer schedule picker.

search
Any of:
string

Substring filter on schedule name + description. Case-insensitive on the underlying SQL.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

Envelope for GET /schedules.

object
data
required
Array<object>

One row in the schedule picker. id feeds schedule_id on the launch body.

object
description
Any of:
string
id
required

Schedule UUID; pass back to launch / PATCH endpoints.

string
is_archived

Archived schedules are excluded by default — pass include_archived=true to include them.

boolean
name
required

Display name as set in the Sequencer schedule UI.

string
timezone
required

IANA timezone name applied to every window (e.g. ‘Europe/Madrid’).

string
windows

Per-day send windows for the schedule. Days with no window are omitted.

Array<object>

One day’s send window — flattens {start, end} from the sequencer.

Days that are absent from the underlying config (= no sending) are omitted from the response rather than serialized as nulls — keeps the response compact and matches the picker UI’s behaviour.

object
day
required

Lowercase day name: monday | tuesday | wednesday | thursday | friday | saturday | sunday.

string
end
required

Window end, 24h HH:MM in timezone.

string
start
required

Window start, 24h HH:MM in timezone.

string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string