Get eSIMs list

GET

/v2/sims

This endpoint allows you to retrieve a list of your eSIMs from the Airalo Partners API. You can customize the results using various filters and include related data in the response by specifying optional parameters.

The access token, obtained from the "Request Access Token" endpoint, should be included in the request.

direct_apple_installation_url:

Partner API now supports direct installation on iOS devices. With the introduction of Universal Links by Apple, users with iOS 17.4 or higher can directly install eSIMs using a special URL, which can be provided to your end clients if they are using iOS version 17.4 or above.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/v2/sims' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Response Example

422 - eSIMs List (422)

{
  "data": {
    "limit": "The limit must be an integer."
  },
  "meta": {
    "message": "the parameter is invalid"
  }
}

Request

Query Params

include

string

optional

Optional. A comma-separated string to include related data in the response. Possible values are "order", "order.status", "order.user" and "share".

Example:

order,order.status,order.user,share

filter[created_at]

string

optional

Optional. A string to filter eSIMs by their creation date. Specify the date range using a dash (-) as a delimiter for correct parsing.

Example:

Y-m-d - Y-m-d

filter[iccid]

string

optional

Optional. A string to filter eSIMs by their ICCID. This performs a like search using the format '%SIM_ICCID%'.

Example:

8944465400000217735

limit

string

optional

Optional. An integer specifying how many sims will be returned on each page.

Example:

100

page

string

optional

Optional. An integer specifying the pagination's current page.

Example:

Header Params

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {{token}}

Responses

🟠422eSIMs List (422)

application/json

Body

data

object

required

limit

string

required