API v2.5 / eSIMs / List eSIMs

Server eSIMGo API - https://api.esim-go.com/v2.5

GET

/esims

• eSIMGo API

This endpoint retrieves all eSIMs currently assigned to your organization. It provides a comprehensive view of your eSIM inventory with flexible options for data retrieval and management.

Key Features:

1. Pagination: Efficiently manage large datasets by specifying the page number and items per page.
2. Sorting: Customize the order of results using the ‘direction’ and ‘orderBy’ parameters.
3. Filtering: Refine your search with multiple filter options for precise data retrieval.

Authorizations

• apiKeyAuth

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

filterBy

string

Allowed values: iccid, customerRef, lastAction, actionDate, assignedDate

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.

filter

string

Value 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

msisdn

MSISDN of ESIM. This only available on eSIMs with a Domestic Bundle applied (i.e. Voice and/or SMS)

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

physical

Type of SIM

boolean

assignedDate

The date of ESIM’s first assignment

string

Example

{
  "esims": [
    {
      "iccid": "8901234567890123456",
      "customerRef": "CUST001",
      "lastAction": "Bundle Applied",
      "actionDate": "2023-05-15T14:30:00Z",
      "physical": false,
      "assignedDate": "2023-05-01T10:00:00Z"
    },
    {
      "iccid": "8909876543210987654",
      "customerRef": "CUST002",
      "lastAction": "Activated",
      "actionDate": "2023-05-16T09:15:00Z",
      "physical": true,
      "assignedDate": "2023-05-10T11:30:00Z"
    }
  ]
}

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

429

Too Many Requests

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