eSIM
List eSIM status history
Experimental. This endpoint is still settling — its request and response shape may change without a deprecation cycle.
Retrieves the recorded status changes for an eSIM, newest first. Each entry names
the status the eSIM moved to and the one it came from, so the current status
returned by the eSIM endpoint is the status of the first entry.
reason is carried only by a faulted entry, where it states why the profile
failed to reach the device using the same normalized cause as the esim.faulted
webhook. That makes the cause recoverable after the fact, independently of whether
the webhook delivery was processed. Every other entry carries reason: null: what
happened is already given by status and previousStatus.
/profiles/{profileReference}/esims/{esimReference}/updatesAuthorization
Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works
Path parameters
profileReferencestringrequiredThe eSIM's profile reference (16-digit numeric string)
esimReferencestringrequiredeSIM reference identifier (18-digit opaque token)
Query parameters
limitintegerMaximum number of items to return (1-100)
20cursorstringOpaque cursor token for fetching the next page. Pass the nextCursor value from a previous response.
Responses
200eSIM status historyapplication/jsonShow response bodyHide response body
dataarray of EsimUpdaterequiredStatus changes, newest first
Show propertiesHide properties
profileReferencestringrequiredesimReferencestringrequiredeSIM reference identifier (18-digit opaque token)
statusstringrequiredThe status the eSIM moved to. Current values are released, downloaded, installed, enabled, disabled, deleted and faulted; entries recorded by earlier imports may carry other values, so treat it as an open set.
previousStatusstring | nullrequiredThe status the eSIM came from; null for the entry that first recorded a status.
sourcestringrequiredWhat kind of actor recorded the change.
apiwebhooksyncmanualadminreasonstring | nullrequiredNormalized cause of the failure, carried only by a faulted entry and matching the reason of the esim.faulted webhook. null on every other entry, and on a faulted entry recorded before its cause was classified.
download_order_expireduser_rejecteddownload_faileddevice_out_of_memoryalready_installedinstall_interruptedinstall_failedunknownnullchangedAtstring · date-timerequiredpaginationobjectrequiredShow propertiesHide properties
limitintegerrequiredMaximum items per page
hasMorebooleanrequiredWhether there are more items after this page
nextCursorstring | nullrequiredOpaque cursor token for the next page. Null when there are no more results.
401Unauthorized - missing or invalid API key403Forbidden - client does not have access to this resource404Resource not found429Rate limit exceeded500Internal server error