List eSIMs

GET

/esims

eSIMGo API

Returns all eSIMs currently assigned to your organisation.

Authorizations

apikeyAuth

Parameters

Query Parameters

page

string

Page of ESIMs to return

Example

<string>

perPage

integer

Number of ESIMs to return per page

Example

direction

string

Direction of ordering

Example

asc

orderBy

string

Name of column to order by

Example

iccid

filterBy

string

Name of column to filter by. eSIMs can be filtered by ICCID, Customer Reference, Last Action (Bundle Refund, Bundle Applied, Bundle Revoked, eSIM Updated, eSIM Refreshed, eSIM Utilisation Alert), Last Action Date and SIM Assignment Date.

Example

iccid, customerRef, lastAction, actionDate, assignedDate

filter

string

Value to filter by

Example

<string>

Responses

200

object

Example

{
  "esims": [
    {
      "iccid": "<string>",
      "customerRef": "<string>",
      "lastAction": "<string>",
      "actionDate": "<string>",
      "physical": "<boolean>",
      "assignedDate": "<string>"
    },
    {
      "iccid": "<string>",
      "customerRef": "<string>",
      "lastAction": "<string>",
      "actionDate": "<string>",
      "physical": "<boolean>",
      "assignedDate": "<string>"
    }
  ]
}

400

Bad Request

object

Example

{
  "message": "<string>"
}

403

Forbidden

object

Example

{
  "message": "<string>"
}

500

Internal Server Error

object

Example

{
  "message": "<string>"
}