Skip to content

Get Org Sequence Calendar

GET
/sequencer/calendar/org

The organisation’s sequence calendar: what is sending when, grouped by sequence, channel, mailbox or owner.

Only sequences the key may see (its sequence scope) and lists it may read appear. scope=personal is “sequences I own”; an organisation key has no person behind it and gets 403 - use team.

Authorizations

Parameters

Query Parameters

tz

IANA time zone the windows and hours are expressed in.

string
default: UTC

IANA time zone the windows and hours are expressed in.

start
Any of:
string

Window start (ISO 8601).

end
Any of:
string

Window end (ISO 8601).

group_by
string
default: sequence
Allowed values: sequence channel mailbox owner
granularity
string
default: hour
Allowed values: hour day
scope

personal is the sequences the caller owns and needs a personal key; an organisation key uses team.

string
default: team
Allowed values: personal team archived

personal is the sequences the caller owns and needs a personal key; an organisation key uses team.

show_projected

Include projected (not yet scheduled) times. 400 projection_disabled while off.

boolean

Include projected (not yet scheduled) times. 400 projection_disabled while off.

show_drafts
boolean
statuses
Any of:
string

Comma-separated sequence statuses.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A sequence calendar read or action result (plan, when, who, org calendar, skip, send-now), as the app returns it.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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