Skip to content

Get data containing eSIMs from multiple Orders or Bundle assignments

GET
/esims/assignments

Get eSIM SMDP+ details by providing an Order or Apply Reference.

Contains ICCID, SMDP+ address and Matching ID.

Multiple reference’s can be passed in using the query parameter. Use the Accept header to control output format. Supported: text/csv, application/json, application/zip.

Default return value is text/csv. Using application/zip returns a ZIP file containing QR code images (in PNG format).

Authorizations

Parameters

Query Parameters

reference
required
string

Order Reference or Apply Reference

additionalFields
Array<string>
Allowed values: appleInstallUrl

Responses

200

Assignments data

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