List scheduled messages

GET/api/v1/messages/scheduled

Requires anorganization API keywith the scopemessages:send

Your scheduled messages, soonest first — the opposite order to every other list here, because this one is about what is about to happen and newest-first would bury the next send under everything already gone.

Bodies are not echoed back. You already have the message you scheduled, and repeating up to 10 MB of base64 attachments in every row would make the list unusable. What comes back is the envelope: to, from, subject, and what is going to happen to it.

Parameters

Name	In	Type	Description
`status`	query	string	One of `scheduled`, `sending`, `sent`, `cancelled`, `failed`.
`per_page`	query	integer	Page size.

Request

GET/api/v1/messages/scheduled

curl -X GET 'https://app.mailyte.com/api/v1/messages/scheduled' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/messages/scheduled', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/messages/scheduled",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/messages/scheduled');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/messages/scheduled")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

dataobject
- dataarray<object>
  - objectstringscheduled_message
  - idstring
    Address this with GET and DELETE /messages/scheduled/{id}. It identifies the SCHEDULE, not the message — see message_id.
  - statusstringscheduled | sending | sent | cancelled | failed
    scheduled (waiting), sending (going out now; it can no longer be cancelled), sent, cancelled or failed.
  - modestringlive | test
    test when a test API key scheduled this message: when it is due it is stored in your Sandbox, never delivered. Otherwise live.
  - send_atstring
    When it will be sent, to the minute.
  - fromstring
    The sender, as scheduled.
  - toarray<string>
    The recipients, as scheduled. cc and bcc are held but not published back — a Bcc that reappears in a readable response is a Bcc that leaked.
  - subjectstring
    null MEANS NONE WAS SET — a message may legitimately have no subject, and a template supplies its own at render time.
  - message_idstring
    The Message-ID it was sent with. Null until it is sent, and for a cancelled or failed message.
  - sent_atstring
    When it was submitted. null MEANS IT HAS NOT BEEN.
  - cancelled_atstring
    When it was cancelled. null MEANS IT WAS NOT.
  - failure_reasonstring
    Why it could not be sent. Set only when status is failed. Suppression and rate limits are checked when the message is sent, not when it was scheduled.
  - created_atstring
    When it was accepted.
- pagination_metaany

Returned inside the standard envelope.

Errors

Status	When
`401`	The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
`403`	The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
`404`	No such resource in this organization.
`422`	The request was understood but the values were not acceptable.
`429`	Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.