Documentation
Sign inGet started

bird contacts list

Usage

Esempio di codice
bird contacts list [flags]

Description

List the workspace's contacts as a cursor page, newest first. Look one up by exact email or external_id, or search by email substring.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Esempio di codice
bird contacts list
bird contacts list | jq -r '.data[].id'
bird contacts list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--emailReturn the contact with exactly this email address (case-insensitive). Email is unique within a workspace, so this matches at most one contact.
--external-idReturn the contact with exactly this external_id (your own identifier for the contact). Unique within a workspace, so this matches at most one contact.
--qCase-insensitive substring match against the contact's email address.
--response-schemaPrint the fields this command returns, then exit

Pagination

NameDescription
--ending-beforeCursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
--limit <n>Maximum number of items to return per page.
--starting-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
NameDescription
bird contacts batchCreate or update many contacts in one request, matched by email.
bird contacts createCreate a contact by email address.
bird contacts deleteDelete a contact
bird contacts getGet a contact
bird contacts updateUpdate a contact's name, email, external-id, or custom data.