GET Get Packages

This endpoint returns a paginated and filtered list of packages associated with the authenticated user.

Configure the API Endpoint

https://esim.betatel.com/api/v1/esim/packages

• Method: GET

Set Up the Headers

Param	Value	Description
Content-Type	application/json	Specifies the payload format.
x-api-key	{{x-api-key}}	Your unique API key for secure access.
x-user-id	{{x-user-id}}	Your user identifier for added security and tracking.

Query Parameters

Tip: Utilize query parameters like 'status' for more focused search results within the packages, offering better filtering options.

Param	Type	Required	Default	Description
count	integer	optional	-	Number of items to return
offset	integer	optional	-	Number of items to skip
inventory	integer	optional	-	Filter by inventory ID
package_template	integer	optional	-	Filter by package template ID
sim	string	optional	-	Filter by SIM ICCID
status	string	optional	-	Filter by package status (NOT_ACTIVE, ACTIVE, SUSPENDED, TERMINATED)

Example Response

Status Code: 200 OK
Content-Type: application/json

Example Response

{
  "total": 100,
  "offset": 0,
  "count": 20,
  "packages": [
    {
      "id": "pkg_123456",
      "sim": "89148000004012345678",
      "package_template": 21145354,
      "status": "ACTIVE",
      "created_date": 1761330317000,
      "activated_date": 1761330517000,
      "expiry_date": 1763922517000
    }
  ]
}

The response includes the total number of packages matching filters, current pagination offset, number of items returned, and an array of package objects.

Code Snippets

Info: These code snippets provide a quick way to interact with the API. Understand how the headers and parameters are constructed.

cUrl

Example - cURL

curl --location 'https://esim.betatel.com/api/v1/esim/packages?offset=0&count=20' \
--header 'Accept: application/json' \
--header 'x-api-key: {{x-api-key}}' \
--header 'x-user-id: {{x-user-id}}'

Python

Example - Python

import http.client

conn = http.client.HTTPSConnection("esim.betatel.com")
headers = {
  'Accept': 'application/json',
  'x-api-key': '{{x-api-key}}',
  'x-user-id': '{{x-user-id}}'
}
conn.request("GET", "/api/v1/esim/packages?offset=0&count=20", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Node.js

Example - Node.js

const axios = require('axios');

axios.get('https://esim.betatel.com/api/v1/esim/packages', {
  params: {
    offset: 0,
    count: 20
  },
  headers: {
    'Accept': 'application/json',
    'x-api-key': '{{x-api-key}}',
    'x-user-id': '{{x-user-id}}'
  }
})
.then((response) => {
  console.log(response.data);
})
.catch((error) => {
  console.log(error);
});

PHP

Example - PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://esim.betatel.com/api/v1/esim/packages?offset=0&count=20',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Accept: application/json',
    'x-api-key: {{x-api-key}}',
    'x-user-id: {{x-user-id}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

Example - Java

HttpResponse<String> response = Unirest.get("https://esim.betatel.com/api/v1/esim/packages?offset=0&count=20")
  .header("Accept", "application/json")
  .header("x-api-key", "{{x-api-key}}")
  .header("x-user-id", "{{x-user-id}}")
  .asString();
System.out.println(response.getBody());

C#

Example - C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://esim.betatel.com/api/v1/esim/packages?offset=0&count=20");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "{{x-api-key}}");
request.Headers.Add("x-user-id", "{{x-user-id}}");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Error Handling

Important: Pagination parameter errors, such as setting an invalid count or offset, will return a '400' status code.

• 400 - Bad Request - Invalid pagination parameters