Simcard Detail

This API endpoint retrieves detailed information about a specific SIM card associated with an enterprise.

Performance tip

By default (with_products=1) the response includes the full purchasable product catalogue and can reach ~1.7 MB. Pass with_products=0 to omit the catalogue if you only need the SIM details/usage — the response shrinks to a few KB and is much faster.

Example Response

{
  "success": true,
  "data": {
    "simcard_details": {
      "simcard_id": "",
      "imsi": "",
      "iccid": "",
      "esim": true,
      "name": "",
      "qr_code": "",
      "qr_code_image": "",
      "smdp_address": "",
      "ios_universal_installation_link": "",
      "matching_id": "",
      "default_view": true,
      "apn": "",
      "imsi_provider_imsi_id": "",
      "imsi_provider_name": "",
      "imsi_provider_enabled": "",
      "imsi_provider_esim": true,
      "simcard_status": "",
      "provider": "",
      "products": [
        {
          "id": "",
          "creation_timestamp": "",
          "last_update_timestamp": "",
          "name": "",
          "duration": "",
          "minutes": "",
          "volume_home_countries": "",
          "price": "",
          "description": "",
          "type": "",
          "external_id": "",
          "country": "",
          "volume": "",
          "visible": "",
          "throttled_volume": "",
          "is_trial": "",
          "provider": "",
          "admin_visible": "",
          "app_visible": "",
          "consumer": "",
          "enterprise": "",
          "iot": "",
          "is_throttled": "",
          "region_names": "",
          "has_subscription": "",
          "linked_product": "",
          "popular": "",
          "unlimited": "",
          "deal": "",
          "deal_type": "",
          "wc_product": "",
          "upgrade_to": "",
          "imsi_id": "",
          "catalog_selected": "",
          "app_selected": "",
          "validity_label": "",
          "currency_postfix_label": "",
          "full_price": "",
          "activation_type": "",
          "sms": "",
          "plan_renewal_price": "",
          "external_policy_id": null,
          "sku": null,
          "product_coverage": [
            {
              "country": "",
              "country_name": "",
              "country_iso2": ""
            }
          ]
        }
      ],
      "is_gid": true,
      "has_sha": true,
      "is_esim_re_installable": 0,
      "state": "",
      "data_credit_verbose": "",
      "permanent_roaming_protection": true,
      "data_credit_details": [],
      "show_data_enabled": true,
      "simcard_sharing_info": [],
      "license_cli": null
    },
    "code": 0
  }
}

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer

(Required) The iccid of the simcard you want to retrieve the details

integer

(Optional, default 1) With the default value 1 the response embeds the full purchasable product catalogue (~1.7 MB). Set it to 0 if you only need SIM status/usage: the response drops to a few KB and is significantly faster.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json