Skip to content

List eSIMs assigned to you

GET
/esims

Returns all eSIMs currently assigned to your organisation.

Authorizations

Parameters

Query Parameters

page
string

Page of ESIMs to return

perPage
integer

Number of ESIMs to return per page

direction
string
Allowed values: asc desc

Direction of ordering

orderBy
string
Allowed values: iccid

Name of column to order by

filter
string

Value to filter by

filterBy
string
Allowed values: iccid

Name of column to filter by

Responses

200

A list of your eSIMs

object
esims
Array<object>
object
iccid

ICCID of ESIM

string
customerRef

Reference of ESIM

string
lastAction

Last action performed on the ESIM (e.g. Bundle Applied)

string
actionDate

The date of the Last Action performed on the ESIM

string

400

Bad Request - returned when incorrect data given

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