bird email ip-pools workspaces list
Usage
Code example
bird email ip-pools workspaces list <ip-pool-id> [flags]Description
List the workspaces an organization IP pool is assigned to, with whether it is each workspace's default. Workspaces with no assigned pools send through the shared pool without appearing here.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird email ip-pools workspaces list <ip-pool-id>
bird email ip-pools workspaces list <ip-pool-id> | jq -r '.data[].ip_pool_id'
bird email ip-pools workspaces list <ip-pool-id> --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. |
--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 | Sort by created_at, when the pool was assigned. Defaults to created_at. 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. |
Filters
| Name | Description |
|---|---|
--response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
bird email ip-pools workspaces assign | Assign an IP pool to a workspace |
bird email ip-pools workspaces remove | Remove an IP pool from a workspace |
Related resources
Continue with the documentation, guides and examples for this topic.