Get eSIMs

Production

https://api.getroamify.com

GET

/api/esims

Last modified:2025-01-06 23:19:20

Maintainer:Not configured

To get a list of eSIMs, you need to send a GET request to the /api/esims endpoint.

There are no required parameters for this endpoint, but you can provide the following optional parameters:

status: The status of the eSIM orders. This is an optional field of type string. It can be any of the following values:

NEW: New eSIM, not yet processed

READY: eSIM is ready to be downloaded

INSTALLED: eSIM has been installed

REVOKED: eSIM has been revoked

EXPIRED: eSIM has expired

UNKNOWN: Unknown status

limit: The number of eSIM orders to return. This is an optional field of type number. The default value is 50.

Request

Query Params

status

string

required

NEW,READY,INSTALLED,REVOKED,EXPIRED,UNKNOWN

Example:

NEW

limit

string

required

default is 50

Example:

Header Params

User-Agent

string

required

Example:

insomnia/10.1.1

Authorization

string

required

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.getroamify.com/api/esims?status=NEW&limit=50' \
--header 'User-Agent: insomnia/10.1.1' \
--header 'Authorization: token'

Responses

🟢200successfully / 200

text/plain

Body

object {0}

Example

application/json; charset=utf-8 content type is not supported in the response body

Modified at 2025-01-06 23:19:20

Get eSIM Packages History

Get eSIM