Skip to content

TelliSIM API v3 (1.0.0)

API explanation

API explanation diagram

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Languages
Servers
Production server
https://api.tellisim.com/

Subscriptions

Operations related to subscriptions.

Operations

Plans

Operations related to plans.

Operations

Coverage

Operations related to coverage.

Operations

SIM

Operations related to SIM management.

Operations

List SIMs

Request

This endpoint retrieves a list of SIMs(both eSIMs and physical sim cards) associated with organization.

Security
ApiKeyAuth
Query
page_sizestring
pagestring
is_esimboolean
labelstring
Example: label=Green
curl -i -X GET \
  'https://api.tellisim.com/v3/sims?page_size=string&page=string&is_esim=true&label=Green&key=YOUR_API_KEY_HERE'

Responses

Successful response containing a list of SIMs

Bodyapplication/json
errorbooleanrequired

Indicates whether an error occurred during the request

Example: false
dataArray of objects(ESIM)required

Contains an array of SIM objects

data[].​iccidstringrequired

The Integrated Circuit Card Identifier of the eSIM

Example: "8937103400004164763"
data[].​labelstringrequired

A label for the eSIM

Example: "Blue"
data[].​lpastring or null

The Local Profile Assistant associated with the eSIM if the SIM is an eSIM

Example: "LPA:1$rsp-eu.redteamobile.com$0F222CA0C9B2F3A99457DADC94A4958C"
data[].​usedboolean

Indicates if the SIM has been used or not

Example: false
data[].​esim_idstringrequired

The unique identifier for the eSIM

Example: "5a15183b-ca25-4725-b8a8-807990f98e03"
data[].​created_atstring(date-time)required

The timestamp when the SIM was created

Example: "2025-08-11T14:43:15.761Z"
data[].​is_esimbooleanrequired

Indicates if the item is an eSIM or not

Example: true
next_pagestring or nullrequired

A token for pagination, indicating if there are more results available

Example: "MQ=="
Response
application/json
{
  "error": false,
  "data": [
    { … }
  ],
  "next_page": "MQ=="
}

Get SIM details

Request

This endpoint retrieves the details of a specific SIM by its ICCID.

Security
ApiKeyAuth
Path
iccidstringrequired
curl -i -X GET \
  'https://api.tellisim.com/v3/sims/{iccid}?key=YOUR_API_KEY_HERE'

Responses

Successful response containing the SIM details.

Bodyapplication/json
errorboolean
dataobject(ESIM)
Response
application/json
{
  "error": true,
  "data": {
    "iccid": "8937103400004164763",
    "label": "Blue",
    "lpa": "LPA:1$rsp-eu.redteamobile.com$0F222CA0C9B2F3A99457DADC94A4958C",
    "used": false,
    "esim_id": "5a15183b-ca25-4725-b8a8-807990f98e03",
    "created_at": "2025-08-11T14:43:15.761Z",
    "is_esim": true
  }
}

Get SIM SMDP information

Request

This endpoint retrieves the SM-DP+ (Subscription Manager Data Preparation) information for a specific SIM by its ICCID.

The response includes the state history of the eSIM profile with the following possible states:

  • BPP Installation: The process of downloading and installing the eSIM profile via a Bootstrap Provisioning Platform (BPP)
  • Enable: eSIM is switched on from device settings, allowing it to connect to the mobile network
  • Disable: eSIM is turned off via device settings, temporarily preventing it from being used
  • Delete: eSIM profile is completely removed from the device
Security
ApiKeyAuth
Path
iccidstringrequired

The ICCID of the SIM

curl -i -X GET \
  'https://api.tellisim.com/v3/sims/{iccid}/smdp-info?key=YOUR_API_KEY_HERE'

Responses

Successful response containing the SMDP information.

Bodyapplication/json
errorboolean
Example: false
dataobject(SMDPInfo)
Response
application/json
{
  "error": false,
  "data": {
    "iccid": "8948010000031326267",
    "state_history": [ … ],
    "current_status": "Enable"
  }
}

Operators

Operations related to operators.

Operations

Webhook Events

Operations related to webhook events.

Webhooks