Skip to Content
OpenRoam Docs
eSIMs

eSIM catalog

Returns every destination with its plans, page by page, for partner inventory.

GET
/v1/esims/catalog

Returns every destination with its plans, page by page, for partner inventory.

Returns { items, nextCursor }, in a fixed order, with the search filters except iccid. Continue with nextCursor as cursor, the same filters and the same currency until it is null. A cursor reused with other filters or another currency gives 400 / 10001. Quote confirms the final price and availability.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Query Parameters

countryCode?string

Optional ISO 3166-1 alpha-2 country, in either case: keeps the destinations whose coverage includes it, regional and global ones too. A blank value is rejected.

category?string

Keep local, regional or global destinations.

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

Keep the destinations of this region, in display or slug form, for example North America or north-america.

validityDays?integer

Keep the plans valid for exactly this many days; at least 1.

Formatint32
isUnlimited?boolean

Keep the unlimited (true) or the limited (false) plans.

currency?string

Price currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at currency, reason NOT_SUPPORTED.

cursor?string

The nextCursor of the previous page; omit it for the first page. Reuse it only with the same filters and currency.

limit?integer

Page size, 1 to 100; default 100.

Formatint32

Response Body

OK

  1. response

A page of the partner catalog walk, in a fixed order. Continue with nextCursor, the same filters and the same currency until it is null.

items*array<>
nextCursor?string|null
Example Request
curl -X GET 'https://api.sandbox.openroam.com/v1/esims/catalog?countryCode=FR&category=regional&region=Europe&validityDays=7&isUnlimited=false&currency=USD&limit=10'
Example Response
{  "items": [    {      "id": "string",      "name": "string",      "countryCode": "string",      "category": "local",      "logoUrl": "string",      "description": "string",      "offers": [        {          "publicId": "string",          "name": "string",          "description": "string",          "price": {            "amount": 0,            "currency": "string"          },          "requiredInputs": [            {              "name": "string",              "type": "text",              "required": true,              "description": "string",              "fields": [                {}              ]            }          ],          "details": {            "validityDays": 0,            "data": {              "amount": 0,              "unit": "string",              "isUnlimited": true,              "label": "string"            },            "voice": {              "amount": 0,              "unit": "string",              "isUnlimited": true,              "label": "string",              "type": "string"            },            "sms": {              "amount": 0,              "unit": "string",              "isUnlimited": true,              "label": "string",              "type": "string"            },            "apn": {              "apn": "string",              "apnUsername": "string",              "apnPassword": "string"            },            "properties": {              "withKyc": true,              "withTopUp": true,              "withHotspot": true,              "withDataRoaming": true,              "withSubscription": true,              "withDestinationInstall": true,              "withUsageCheck": true,              "technology": "string",              "activation": "string",              "charge": "string"            },            "restrictions": {              "throttle": true,              "throttleSpeed": 0,              "throttleUnit": "string",              "throttleThreshold": 0,              "throttleThresholdUnit": "string",              "expireInDays": 0            },            "notes": [              "string"            ],            "plan": "string"          }        }      ],      "details": {        "destinationCode": "string",        "region": "string",        "coverage": [          {            "countryCode": "string",            "name": "string",            "networks": [              "string"            ],            "carriers": [              "string"            ]          }        ]      }    }  ],  "nextCursor": "string"}