bird email seeding sources list
Usage
bird email seeding sources list [flags]Description
Read retained source observations using the original email or broadcast ID; no settings read is
required. Scheduled or skipped sources can have no run; call bird email seeding runs get when a
run_id is returned. Captured establishes that the example was saved, without proving seed sending.
A mixed_recipients skip creates no automatic run; ordinary copies may still send. An empty page
establishes only that this response has no retained matching observation. Reads can lag, history
can expire, or no observation may exist; absence cannot distinguish these causes or establish
whether seeding ever started or delivered. The original email's status is separate from seed-copy
outcomes. Missing history does not authorize a new example or manual seed-test registration.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Procedure
Step 3 of 3 of "Submit an Automatic Email Seeding example". Previous: bird email send. Step 1 of 3 of "Inspect Automatic Email Seeding activity". Next: bird email seeding runs list.
Examples
bird email seeding sources list
bird email seeding sources list | jq -r '.data[].source'
bird email seeding sources list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
--created-after | 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-before | 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. |
--response-schema | Print the fields this command returns, then exit |
--source-broadcast-id | Match an original broadcast. Cannot be combined with source_email_id. If source_kind is supplied, it must be broadcast; conflicting combinations return 422. |
--source-email-id | Match an original email. Cannot be combined with source_broadcast_id or source_kind=broadcast; either combination returns 422. |
--source-kind | Match the original source kind. Possible values: api, smtp, scheduled, broadcast. |
--state | Match the capture observation state. Possible values: scheduled, capturing, captured, skipped, stopped, failed. |
Pagination
| Name | Description |
|---|---|
--ending-before | 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-total | When true, the response includes a total field with the total number of items matching the request's filters across all pages. |
--limit <n> | Maximum number of items to return per page. Allowed range: 1 to 100. |
--order | 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. |
--sort | Field to sort by. Possible values: created_at. |
--starting-after | Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order. |
Related resources
Continue with the documentation, guides and examples for this topic.