List scheduled messages

Pending 1:1 messages created with POST /messages scheduled_at.

GET/v1/scheduled_messages

Details

Batches list their own recipients.

Responses

200Page of ScheduledMessage
Pending scheduled messages, soonest first
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429Error
Rate limit or quota exceeded

Response Fields

The body is a page: data (the array), has_more, and next_cursor (null on the last page). Each item in data:

idstring
Example: job_1759400000000a1B2c3D4e5.
objectscheduled_message
tostring
fromstring
bodystring
scheduled_atstring (date-time)
When it will send. The same name as the request field.
run_atstring (date-time)
Deprecated alias of scheduled_at (same value), kept for existing integrations.
deferredobject
Present on the response when the message was held for quiet hours.
deferred.reasonquiet_hours
deferred.recipient_local_timestring
24-hour wall clock in timezone. Example: 22:41.
deferred.timezonestring
IANA zone read from the area code of the number. Example: America/New_York.
deferred.send_afterstring (date-time)
deferred.categorymarketing
deferred.category_basisrequest, broadcast, sender_registration
statusqueued, canceled
batch_idstring
Nullable.

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429
Rate limit or quota exceeded

const res = await fetch('https://api.jointextkit.com/v1/scheduled_messages', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 200

{
  "data": [
    {
      "id": "job_1759400000000a1B2c3D4e5",
      "object": "scheduled_message",
      "status": "queued"
    }
  ],
  "has_more": true,
  "next_cursor": null
}