API v2.3 / eSIMs / Get history of an eSIM

Server eSIMGo API - https://api.esim-go.com/v2.3

GET

/esims/{iccid}/history

• eSIMGo API

Return the history of an eSIM.

Bundle Assignment States:

• Processing: The bundle assignment is currently processing. This is usually instant but can, on occasion, take up to 10 minutes to complete. The eSIM can still be installed and will register on a network while the bundle is processing.

• Queued: The bundle has been successfully assigned, has not been used yet, and is queued for use.

• Active: The bundle has successfully been used. It has data remaining and is within the bundle duration.

• Depleted: The bundle has no data remaining but is still within the bundle duration.

• Expired: The bundle has expired, and the bundle duration has been exceeded.

• Revoked: The bundle has been revoked, and is no longer on the esim.

Authorizations

• apiKeyAuth
• apiKeyQueryAuth

Parameters

Path Parameters

iccid

required

string

The ICCID of the eSIM

Responses

200

ESIM History

Array<object>

object

name

Action Name

string

bundle

Bundle Name

string

date

Action Date

Format as defined in RFC 3339, section 5.6. Timezone is UTC (ends with ‘Z’). Example: 2006-01-02T15:04:05Z

string

bundleState

Current state of a bundle. Supported: processing,queued, active, depleted, expired, revoked

string

alertType

The type of alert (If applicable) e.g. 1% Used, 50% Used

string

400

Bad Request - returned when the given ICCID is not found and/or permission to view this ICCID is not granted

object

message

Status of api functions which do not return data

string

403

Unauthorised - returned when the api token is invalid

object

message

Status of api functions which do not return data

string

500

Server Error

object

message

Status of api functions which do not return data

string