esim-zones

Get an eSIM coverage zone

Returns one coverage zone with its authoritative country list.

get/v1/esim/zones/{zone_id}

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/esim/zones/{zone_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

zone_idstring required
Example:ezn_01krdgeqcxet5s7t44vh8rt9mg

Zone ID.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

The zone.

idstring required
namestring required

Human-readable zone name.

revisioninteger required

Increments whenever the country list changes.

type'local' | 'regional' | 'global' required

Zone breadth: a single country, a multi-country region, or worldwide.

countriesCountryCode[] required

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

created_atstring date-time required

Example response

{
  "id": "ezn_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Europe",
  "countries": [
    "US"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.