Skip to Content
OpenRoam Docs
eSIMs

List eSIM destinations

Lists every destination with an orderable plan, as summaries without plans.

GET
/v1/esims/destinations

Lists every destination with an orderable plan, as summaries without plans.

Returns the complete list { items }, ordered by name, without paging or prices. Read a destination's plans with destinations/{id}.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Query Parameters

category?string

Filter by category: local, regional or global.

Value in"local""regional""global"
region?string

Filter by region name (e.g. "Europe", "North America"), in display or slug form.

Response Body

OK

  1. response

Every destination with an orderable offer, ordered by name. The list is small, so it is not paged.

items*array<>
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/esims/destinations?category=regional&region=Europe'
Example Response
{  "items": [    {      "id": "string",      "name": "string",      "countryCode": "string",      "category": "local",      "logoUrl": "string"    }  ]}