Esim List

GET

http://localhost:3001/v1/esims

GET

/v1/esims

1 const url = 'http://localhost:3001/v1/esims?filter=active';
2 const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 {
2   "esims": [
3     {
4       "id": "string",
5       "name": "string",
6       "slug": "string",
7       "location_logo": "string",
8       "archived": true,
9       "shared": true,
10       "share_hash": "string",
11       "dataUsage": 1.1,
12       "totalData": 1.1,
13       "lastDataUsageUpdateTime": "string",
14       "esimStatus": "string",
15       "expired_time": "string",
16       "created_at": "string",
17       "unused_valid_time": 1.1
18     }
19   ],
20   "pagination": {
21     "total": 1.1,
22     "page": 1.1,
23     "limit": 1.1,
24     "totalPages": 1.1
25   },
26   "counts": {
27     "active": 1.1,
28     "archived": 1.1,
29     "canceled": 1.1
30   }
31 }

Get esim list

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional1-100Defaults to 1

limitintegerOptional1-100Defaults to 10

searchstringOptional

filterenumRequired

Allowed values:

Response

Successful response

esimslist of objects

paginationobject

countsobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error