Sign inGet Started

List automatic seeding source observations

GET
/v1/email/inbox-insights/automatic-seeding/sources
// Requires inbox_insights:read permission in the target workspace.
for await (const source of bird.email.seeding.sources.list({ limit: 25 })) {
  console.log(source.state, source.run_id);
}
Response200
{
  "data": [
    {
      "source": {
        "kind": "api",
        "email_id": "em_01krdgeqcxet5s7t44vh8rt9mg"
      },
      "source_created_at": "2026-05-20T09:14:52Z",
      "retain_until": "2027-06-19T09:14:52Z",
      "state": "captured",
      "run_id": "esrun_01krdgeqcxet5s7t44vh8rt9mg",
      "label": "spring-launch",
      "created_at": "2026-05-20T09:14:53Z",
      "updated_at": "2026-05-20T09:14:58Z"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Read retained capture observations, including scheduled, skipped or failed sources that never created a run. Reads may lag recent writes. When both creation bounds are supplied, created_before must be later than created_after; otherwise the request returns 422.

Query Parameters

sortstring

Field to sort by. Defaults to created_at.

Possible values: created_at

orderstring

Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.

Possible values: asc, desc

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

include_totalboolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

source_kindstring

Match the original source kind.

Possible values: api, smtp, scheduled, broadcast

source_email_idstring

Match an original email. Cannot be combined with source_broadcast_id or source_kind=broadcast; either combination returns 422.

source_broadcast_idstring

Match an original broadcast. Cannot be combined with source_email_id. If source_kind is supplied, it must be broadcast; conflicting combinations return 422.

created_afterstring

Limits the response to resources created at or after this timestamp. Combine it with created_before to select a time window. Use an RFC 3339 timestamp with a timezone offset.

created_beforestring

Limits the response to resources created before this timestamp. Combine it with created_after to select a time window. Use an RFC 3339 timestamp with a timezone offset.

statestring

Match the capture observation state.

Possible values: scheduled, capturing, captured, skipped, stopped, failed

Response Payload

data
array of object
required
Show child attributes
data.source
object
required

Original customer source. This never identifies a generated seed copy. Scheduled means an API-scheduled email.

Show child attributes
data.source_created_at
string
required

Original source execution time.

data.retain_until
string
required

Time after which the observation is unavailable.

data.state
string
required

State of the source example, separate from the run's sending progress:

  • scheduled: the API-scheduled source is waiting for its due time; capture has not started.
  • capturing: capture is in progress and can already have an associated run.
  • captured: immutable example content was committed for a run; this does not mean seeds were sent.
  • skipped: the source did not complete eligible capture. The reason explains the refusal; a run can exist if refusal occurred after admission.
  • stopped: the scheduled source was canceled; capture will not continue.
  • failed: the scheduled source failed; capture will not continue. Source observations can exist without a run. run_id is present only while an associated run is retained.

Possible values: scheduled, capturing, captured, skipped, stopped, failed

data.reason
string

Sanitized capture reason; absent for a successful or pending observation.

Possible values (may grow over time): registration_rejected, allowance_exhausted, selection_unavailable, sending_domain_not_measured, vendor_outcome_unknown, invalid_registration_response, canceled_or_expired, run_stopped, settings_disabled, trigger_rotated, dispatch_deadline_exceeded, control_rejected, source_stopped, conflicting_examples, unsupported_source, mixed_recipients, invalid_trigger, seeding_unavailable, contact_template_unsupported, source_not_authorized, content_blocked, capture_expired, capture_failed, preparation_unavailable, policy_refused, unavailable, bounced, rejected, blocked, canceled, provider_outcome_unknown, admission_uncertain, admission_refused

data.run_id
string
data.label
string

Label from a trigger address, such as spring-launch in <token>+spring-launch@.... It is a display name and selects nothing.

data.created_at
string
required
data.updated_at
string
required
next_cursor
nullable string
required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

total
nullable integer

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed, and omitted otherwise.

Continue with the documentation, guides and examples for this topic.