Sign in
SupersimV1EsimProfile

Retrieve a list of eSIM Profiles.

Retrieve a list of eSIM Profiles.

get/v1/ESimProfiles

Query parameters

Eidstring

List the eSIM Profiles that have been associated with an EId.

SimSidstring

Find the eSIM Profile resource related to a Sim resource by providing the SIM SID. Will always return an array with either 1 or 0 records.

Status'new' | 'reserving' | 'available' | 'downloaded' | 'installed' | 'failed'

The status of the eSIM Profile. Can be: new, reserving, available, downloaded, installed or failed. See the eSIM Profile Status Values for a description of each.

List the eSIM Profiles that are in a given status.

PageSizeinteger

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Pageinteger

The page index. This value is simply for client state.

PageTokenstring

The page token. This is provided by the API.

Response

OK

Changes

Changed in 5 of the 50 revisions of this API.35

  • v140aef886b3031See the full diff
    • ▲

      for the query request parameter PageSize, the format changed from no format to int64

      request-parameter-type-changed

  • v14c8f6063ae9d1See the full diff
    • ○

      api tag SupersimV1EsimProfile added

      api-tag-added

  • v168030faeddb42See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • v1a6e2859a656d2See the full diff
    • ○

      added the new optional query request parameter Page

      new-optional-request-parameter

    • ○

      added the new optional query request parameter PageToken

      new-optional-request-parameter

  • v142d026552cc22See the full diff
    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable