Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eSIM Go eSIMs API

Manage eSIMs, bundle assignments, and install details.

eSIM Go eSIMs API is one of 6 APIs that eSIM Go publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include eSIMs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 12 operations across 10 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 2.4.

Requests are made against a single base URL, https://api.esim-go.com/v2.4.

12 operations 10 paths 7 schemas 1 DELETE8 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.4
Base URL
https://api.esim-go.com/v2.4
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

eSIM Go eSIMs API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Organisation API key. Find it under Account Settings - API Details in your eSIM Go account and send it in the X-API-Key request header.

Paths & Operations 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 8 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

eSIMs 12

Manage eSIMs, bundle assignments, and install details.

GET
/esims
List eSIMs
listEsims 2 params → 200
PUT
/esims
Update eSIM Details
updateEsim body → 200
GET
/esims/{iccid}
Get eSIM details
getEsim 1 param → 200
POST
/esims/apply
Apply Bundle to an eSIM
applyBundleToEsim body → 200
GET
/esims/assignments
Get eSIM Install Details
getEsimInstallDetails 2 params → 200
GET
/esims/{iccid}/history
Get eSIM history
getEsimHistory 1 param → 200
GET
/esims/{iccid}/location
Get eSIM Location
getEsimLocation 1 param → 200
POST
/esims/{iccid}/sms
Send SMS to eSIM
sendEsimSms 1 param body → 200
GET
/esims/{iccid}/bundles
List Bundles applied to eSIM
listEsimBundles 1 param → 200
GET
/esims/{iccid}/bundles/{name}
Get applied Bundle status
getEsimBundleStatus 2 params → 200
DELETE
/esims/{iccid}/bundles/{name}
Revoke applied Bundle
revokeEsimBundle 2 params → 200
GET
/esims/{iccid}/compatible-bundle
Check eSIM and Bundle Compatibility
checkBundleCompatibility 2 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are InstallDetails (9 properties), Esim (8 properties), ApplyBundleRequest (4 properties), EsimList (3 properties). Each schema is shown below with its type and property counts.

AssignmentResult
object
2 properties
InstallDetailsResponse
object
1 property
UpdateEsimRequest
object
2 properties
Esim
object
8 properties
EsimList
object
3 properties
ApplyBundleRequest
object
4 properties
InstallDetails
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

esimgo-esims-api-openapi.yml Raw ↑

Other APIs eSIM Go publishes across the network.

eSIM Go Catalogue API
eSIM Go Inventory API
eSIM Go Networks API
eSIM Go Orders API
eSIM Go Organisation API