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
Returns a paginated list of scheduled sends.
const result = await kraiter.scheduledSends.list({ limit: 20 });
for (const item of result.items) {
console.log(item.contactId, item.templateId, item.scheduledFor);
}Filter by status:
const pending = await kraiter.scheduledSends.list({ status: 'pending' });Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter by status (e.g. "pending"). |
limit | number | No | Maximum items per page. |
cursor | string | No | Pagination cursor. |
Returns
Promise<{ items: ScheduledSendSummary[]; cursor?: string; hasMore: boolean }> — a paginated list of scheduled sends.
Each ScheduledSendSummary object contains:
| Field | Type | Description |
|---|---|---|
scheduledSendId | string | Unique identifier for the scheduled send. |
contactId | string | The contact who will receive the email. |
sequenceId | string | The sequence that created this send. |
stepId | string | The step within the sequence. |
templateId | string | The template that will be rendered. |
scheduledFor | string | ISO 8601 timestamp of when the email will be sent. |
status | string | Current 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
| Parameter | Type | Required | Description |
|---|---|---|---|
scheduledSendId | string | Yes | The scheduled send ID. |
scheduledFor | string | Yes | The 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
| Code | When |
|---|---|
NOT_FOUND | No scheduled send exists with this ID, or it has already been sent. |