`bird esim zones list`

Usage

Code example

bird esim zones list [flags]

List the coverage zones eSIM offers sell, as a cursor page ({data, next_cursor, ...}). Each zone carries its authoritative country list. Filter by country (ISO 3166-1 alpha-2) to find zones covering a destination, then list offers by zone_id to see what can be ordered there.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Procedure

Step 1 of 8 of "Buy and install an eSIM data package". Next: bird esim offers list.

Examples

Code example

bird esim zones list
bird esim zones list | jq -r '.data[].id'
bird esim zones list --limit 50 --starting-after <cursor>

Options

Filters

Name	Description
`--country`	Keep only zones that include this country (ISO 3166-1 alpha-2).
`--response-schema`	Print the fields this command returns, then exit

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. 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`	Field to sort by. Possible values: 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.

Name	Description
`bird esim zones get`	Get an eSIM coverage zone

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources