Documentation
Sign inGet started

bird invitations list

Usage

Code example
bird invitations list [flags]

Description

List the workspace's invitations as a page. Only pending ones come back unless you pass a status filter.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Code example
bird invitations list
bird invitations list | jq -r '.data[].id'
bird invitations 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.
--include-totalWhen 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.
--orderSort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc.
--sortSort by created_at, expires_at, or email. Defaults to created_at. Possible values: created_at, expires_at, email.
--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
--statusReturn pending invitations by default. Choose another status or all to include other lifecycle states. Possible values: pending, accepted, revoked, expired, all.
NameDescription
bird invitations createCreate a workspace invitation
bird invitations getGet a workspace invitation
bird invitations revokeRevoke a workspace invitation