Airalo Developer Platform
  1. Place top up order
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: Get installation instructions
    • User journeys
      • Purchase journey
      • Top-up journey
    • Guides
      • How to set up a brand for eSIMs Cloud link sharing
      • How to get the eSIMs Cloud sharing link through API
      • How to generate the QR code for an eSIM
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Rate limits
    • Error handling
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
        • Get compatible device list
      • Place order
        • Submit order
        • Submit order async
        • Future orders
        • eSIM voucher
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Place top up order
        • Submit top-up order
          POST
        • Get top-up package list
          GET
        • Get eSIMs list
          GET
        • Get eSIM package history
          GET
      • Manage orders & eSIMs
        • Get order list
        • Cancel future orders
        • Get order
        • Update eSIM brand
      • Notifications
        • Airalo webhooks optin and flow
        • Understanding webhooks: Asynchronous communication for modern applications
        • Async orders
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Check balance
        • Get balance
      • Refunds
        • Refund request
    • Guides
      • Step #1 - Authentication
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Guides
      • How to install the plugin
      • How to setup the Shop price?
      • Customizing "My eSIM" page colors in WooCommerce
      • How to convert prices into local currency
      • How to finalize the shop setup
      • How to test in sandbox
      • How to go live
      • Customizing WooCommerce email templates for eSIM sales
  1. Place top up order

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

Query Params

Header Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/v2/sims?include=order,order.status,order.user,share&filter[created_at]=Y-m-d - Y-m-d&filter[iccid]=8944465400000217735&limit=100&page=1' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Responses

🟠422eSIMs List (422)
application/json
Body

Example
{
    "data": {
        "limit": "The limit must be an integer."
    },
    "meta": {
        "message": "the parameter is invalid"
    }
}
🟢200eSIMs List (200)
Modified at 2025-07-10 09:56:07
Previous
Get top-up package list
Next
Get eSIM package history
Built with