Documentation
Sign inGet started

bird contact-properties list

Usage

Code example
bird contact-properties list [flags]

Description

List the workspace's contact properties as a cursor page, newest first. Archived properties are included, marked by their archived flag.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Code example
bird contact-properties list
bird contact-properties list | jq -r '.data[].id'
bird contact-properties list --limit 50 --starting-after <cursor>

Options

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.

Filters

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird contact-properties archiveArchive a contact property
bird contact-properties createDefine a custom contact property.
bird contact-properties getGet a contact property
bird contact-properties unarchiveUnarchive a contact property
bird contact-properties updateUpdate a contact property's fallback value.