Firsty

Search...

Search...

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.

get/profiles/{profileReference}/esims/{esimReference}/updates

Authorization

Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works

Path parameters

profileReferencestringrequired

The eSIM's profile reference (16-digit numeric string)

esimReferencestringrequired

eSIM reference identifier (18-digit opaque token)

Query parameters

limitinteger

Maximum number of items to return (1-100)

Default20
cursorstring

Opaque cursor token for fetching the next page. Pass the nextCursor value from a previous response.

Responses

200eSIM status historyapplication/json
Show response body
dataarray of EsimUpdaterequired

Status changes, newest first

Show properties
profileReferencestringrequired
esimReferencestringrequired

eSIM reference identifier (18-digit opaque token)

statusstringrequired

The 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 | nullrequired

The status the eSIM came from; null for the entry that first recorded a status.

sourcestringrequired

What kind of actor recorded the change.

Optionsapiwebhooksyncmanualadmin
reasonstring | nullrequired

Normalized 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.

Optionsdownload_order_expireduser_rejecteddownload_faileddevice_out_of_memoryalready_installedinstall_interruptedinstall_failedunknownnull
changedAtstring · date-timerequired
paginationobjectrequired
Show properties
limitintegerrequired

Maximum items per page

hasMorebooleanrequired

Whether there are more items after this page

nextCursorstring | nullrequired

Opaque 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