bird organization invitations list
Usage
Code example
bird organization invitations list [flags]Description
List the organization's invitations. 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 organization invitations list
bird organization invitations list | jq -r '.data[].id'
bird organization invitations list --limit 50 --starting-after <cursor>Options
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. |
| --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 | Sort by created_at, expires_at, or email. Defaults to created_at. Possible values: created_at, expires_at, email. |
| --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. |
Filters
| Name | Description |
|---|---|
| --response-schema | Print the fields this command returns, then exit |
| --status | Return pending invitations by default. Choose another status or all to include other lifecycle states. Possible values: pending, accepted, revoked, expired, all. |
Related
| Name | Description |
|---|---|
| bird organization invitations create | Create an organization invitation |
| bird organization invitations get | Get an organization invitation |
| bird organization invitations revoke | Revoke an organization invitation |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Understand the conceptShould I use an API key or an OAuth token, and how do I rotate one?Implementation guideAuthentication & API keys
Get an implementation brief