Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

List eSIM coverage zones

GET
/v1/esim/zones
bird esim zones list
Response200
{
  "data": [
    {
      "id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
      "name": "Europe",
      "type": "local",
      "countries": [
        "US"
      ]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns the coverage zones behind the offer catalog as a cursor-paginated list. A zone's countries list is authoritative for every offer that references it. Filter by country to find zones covering a destination.

Query Parameters

sortstring

Field to sort by. Possible values: created_at.

Possible values: created_at

orderstring

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

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

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_totalboolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

countrystring

Keep only zones that include this country (ISO 3166-1 alpha-2).

Response Payload

data
array of object
required

Zones, newest first.

Show child attributes
data.id
string
required
data.name
string
required

Human-readable zone name.

data.revision
integer
required

Increments whenever the country list changes.

data.type
string
required
data.countries
array of string
required

Countries covered by the zone, as ISO 3166-1 alpha-2 codes.

data.created_at
string
required
next_cursor
nullable string
required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor
nullable string
required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor
nullable string
required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

total
nullable integer

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.

Related resources

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

Get an implementation brief