v1

latestOpenAPI 3.0.12026-07-23122654.9 KB
SupersimV1EsimProfile

Read all ESimProfile resources

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' nullable

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