List eSIM destinations
Lists every destination with an orderable plan, as summaries without plans.
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}.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
category?stringFilter by category: local, regional or global.
"local""regional""global"region?stringFilter by region name (e.g. "Europe", "North America"), in display or slug form.
OK
- response
Every destination with an orderable offer, ordered by name. The list is small, so it is not paged.
items*array<>curl -X GET 'https://api.sandbox.openroam.com/v1/esims/destinations?category=regional®ion=Europe'{ "items": [ { "id": "string", "name": "string", "countryCode": "string", "category": "local", "logoUrl": "string" } ]}Get an eSIM destination GET
Returns one destination with its plans, in the item shape that search returns. An unknown ID, or a destination that search does not list, gives 404 / 10004. After a purchase, the order item's `purchasedProduct.details.destination.id` gives the coverage of the destination the eSIM was bought for.
Get an eSIM GET
Returns one of your eSIMs by its ICCID, with its installation details, plan and top-ups. Returns the eSIM as last recorded, without a live refresh: `esimStatus` and `profileStatus` as the order item names them, the SIM details (LPA code, QR code URL and quick-install links), the plan, its data (MB), SMS (messages) and voice (minutes) allowances, any top-ups, and `expiresAt`, null until the eSIM is activated. An ICCID that is not one of your eSIMs gives 404 / 10004.