Kraiter
SDK Reference

Scheduled Sends

SDK reference for viewing emails scheduled for future delivery in Kraiter.

The kraiter.scheduledSends namespace provides methods for viewing emails that are queued for future delivery, typically created by sequence steps with delays.

list

Lists scheduled sends filtered by status and/or contact. You must provide at least one of status or contactId — the API rejects an unfiltered list with a 400, and the SDK throws before the request is made if both are omitted.

const result = await kraiter.scheduledSends.list({ status: 'pending' });

for (const item of result.items) {
  console.log(item.contactId, item.templateId, item.scheduledFor);
}

Filter by contact instead:

const forContact = await kraiter.scheduledSends.list({ contactId: 'con_abc123' });

Parameters

ParameterTypeRequiredDescription
statusstringConditionalFilter by status (e.g. "pending"). Required unless contactId is given.
contactIdstringConditionalFilter by contact. Required unless status is given.
limitnumberNoMaximum items to return in the single result page.

Returns

Promise<{ items: ScheduledSendSummary[]; hasMore: boolean }> — a single page of scheduled sends. This endpoint has no pagination cursor: hasMore merely signals that more matched than were returned, so raise limit to fetch more.

Each ScheduledSendSummary object contains:

FieldTypeDescription
scheduledSendIdstringUnique identifier for the scheduled send.
contactIdstringThe contact who will receive the email.
sequenceIdstringThe sequence that created this send.
stepIdstringThe step within the sequence.
templateIdstringThe template that will be rendered.
scheduledForstringISO 8601 timestamp of when the email will be sent.
statusstringCurrent status of the scheduled send.

get

Retrieves a single scheduled send by ID.

const item = await kraiter.scheduledSends.get('sch_01H9...', '2025-09-16T14:00:00.000Z');

if (item) {
  console.log(item.templateId, item.scheduledFor, item.status);
}

Parameters

ParameterTypeRequiredDescription
scheduledSendIdstringYesThe scheduled send ID.
scheduledForstringYesThe scheduled delivery timestamp (ISO 8601). Used as part of the lookup key.

Returns

Promise<ScheduledSendSummary | null> — the scheduled send, or null if not found.

Errors

CodeWhen
NOT_FOUNDNo scheduled send exists with this ID, or it has already been sent.