{
  "opencollection": "1.0.0",
  "info": {
    "name": "Soracom and Query Analysis Subscriber API",
    "version": "20250903-043502"
  },
  "items": [
    {
      "info": {
        "name": "Subscriber",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Subscribers.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/subscribers",
            "params": [
              {
                "name": "tag_name",
                "value": "",
                "type": "query",
                "description": "Tag name for filtering the search (exact match)."
              },
              {
                "name": "tag_value",
                "value": "",
                "type": "query",
                "description": "Tag search string for filtering the search. Required when `tag_name` has been specified."
              },
              {
                "name": "tag_value_match_mode",
                "value": "",
                "type": "query",
                "description": "Tag match mode."
              },
              {
                "name": "status_filter",
                "value": "",
                "type": "query",
                "description": "Status for filtering the search. Can specify multiple values delimited by `|`. Valid values include: `active`, `inactive`, `ready`, `instock`, `shipped`, `suspended`, and `terminated`."
              },
              {
                "name": "speed_class_filter",
                "value": "",
                "type": "query",
                "description": "Speed class for filtering the search. Can specify multiple values delimited by `|`. Valid values include:\n\n- `s1.minimum`\n- `s1.slow`\n- `s1.standard`\n- `s1.fast`\n- `s1.4xfast`\n- `s1.8xfast`\n- `u1.standard`\n- `u1.slow`\n- `t1.standard`\n- `arc.standard`\n"
              },
              {
                "name": "serial_number_filter",
                "value": "",
                "type": "query",
                "description": "Serial number for filtering the search. Can specify multiple values delimited by `|`. Returns subscribers with serial number starting with the specified value(s)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of subscribers to retrieve (value range is 1 to 100). However, the number of subscribers returned may be less than the specified value."
              },
              {
                "name": "last_evaluated_key",
                "value": "",
                "type": "query",
                "description": "The IMSI of the last subscriber retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next subscriber onward."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of subscribers that match certain criteria. If the total number of subscribers does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n"
        },
        {
          "info": {
            "name": "Get Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/subscribers/:imsi",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns information about the specified subscriber."
        },
        {
          "info": {
            "name": "Activate Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/activate",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Activates status of specified subscriber."
        },
        {
          "info": {
            "name": "Set Bundles to Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/bundles",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber. The IMSI can be obtained from the [Sim:listSims API](#!/Sim/listSims)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Sets bundles to the specified subscriber."
        },
        {
          "info": {
            "name": "Get data sent from a subscriber to Harvest Data.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/data",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber that generated data entries."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Start time for the data entries search range (UNIX time in milliseconds)."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "End time for the data entries search range (UNIX time in milliseconds)."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort order of the data entries. Either descending (latest data entry first) or ascending (oldest data entry first)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of data entries to retrieve (value range is 1 to 1000). The default is `10`."
              },
              {
                "name": "last_evaluated_key",
                "value": "",
                "type": "query",
                "description": "Key in the last data entry retrieved in the previous page. The key for data entries in this API is `${UNIX time in milliseconds}_${IMSI}`. By specifying this parameter, you can continue to retrieve the list from the next page onward.\n"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a list of data entries sent to Harvest Data from a subscriber that match certain criteria. If the total number of data entries does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n"
        },
        {
          "info": {
            "name": "Deactivate Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/deactivate",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Deactivates specified subscriber."
        },
        {
          "info": {
            "name": "Delete Session",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/delete_session",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Deletes session for the specified subscriber."
        },
        {
          "info": {
            "name": "Disable Termination of Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/disable_termination",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Disables termination of specified subscriber."
        },
        {
          "info": {
            "name": "Send ping requests to a subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/downlink/ping",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Send ICMP ping requests to a subscriber."
        },
        {
          "info": {
            "name": "Enable Termination of Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/enable_termination",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Enables termination of specified subscriber."
        },
        {
          "info": {
            "name": "List Session Events.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/events/sessions",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Start time for the events search range (UNIX time in milliseconds)."
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "End time for the events search range (UNIX time in milliseconds)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of events to retrieve."
              },
              {
                "name": "last_evaluated_key",
                "value": "",
                "type": "query",
                "description": "The time stamp of the last event retrieved on the previous page. By specifying this parameter, you can continue to retrieve the list from the next event onward."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns the event history of session creation/modification/disconnection on the specified subscriber in the last 32 days. If the total number of events does not fit in one page, a URL for accessing the next page is returned in the `link` header of the response.\n"
        },
        {
          "info": {
            "name": "Register Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/register",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Registers a subscriber."
        },
        {
          "info": {
            "name": "Triggers Subscriber to report SIM local info.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/report_local_info",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Triggers Subscriber to report SIM local info."
        },
        {
          "info": {
            "name": "Send SMS to Subscriber",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/send_sms",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Send SMS to the specified subscriber."
        },
        {
          "info": {
            "name": "Update Expiry Time of Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/set_expiry_time",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Updates expiry time of specified subscriber."
        },
        {
          "info": {
            "name": "Adds a SIM to a SIM group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/set_group",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target SIM. The IMSI can be obtained using the [Sim:listSims API](#!/Sim/listSims)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Adds a SIM to a SIM group."
        },
        {
          "info": {
            "name": "Set IMEI lock configuration for Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/set_imei_lock",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Set IMEI that the subscriber should be locked to."
        },
        {
          "info": {
            "name": "Set Subscriber to standby mode.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/set_to_standby",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Set the specified subscriber to standby mode."
        },
        {
          "info": {
            "name": "Suspend Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/suspend",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Suspends the specified subscriber."
        },
        {
          "info": {
            "name": "Bulk Insert or Update Subscriber Tags.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/tags",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Inserts/updates tags for the specified subscriber."
        },
        {
          "info": {
            "name": "Delete Subscriber Tag.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/tags/:tag_name",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              },
              {
                "name": "tag_name",
                "value": "",
                "type": "path",
                "description": "Tag name to be deleted. (This will be part of a URL path, so it needs to be percent-encoded. In JavaScript, specify the name after it has been encoded using encodeURIComponent().)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Deletes a tag from the specified subscriber."
        },
        {
          "info": {
            "name": "Terminate Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/terminate",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Terminates the specified subscriber"
        },
        {
          "info": {
            "name": "Delete Expiry Time of Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/unset_expiry_time",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Deletes expiry time of specified subscriber and changes it to indefinite."
        },
        {
          "info": {
            "name": "Removes a SIM from a SIM group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/unset_group",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target SIM. The IMSI can be obtained using the [Sim:listSims API](#!/Sim/listSims)."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Removes a SIM from a SIM group."
        },
        {
          "info": {
            "name": "Unset IMEI lock configuration for Subscriber.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/unset_imei_lock",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Remove any existing IMEI lock configuration for the subscriber."
        },
        {
          "info": {
            "name": "Update Subscriber speed class.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/:imsi/update_speed_class",
            "params": [
              {
                "name": "imsi",
                "value": "",
                "type": "path",
                "description": "IMSI of the target subscriber."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Changes the speed class of the specified subscriber."
        },
        {
          "info": {
            "name": "Export all subscribers.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/export",
            "params": [
              {
                "name": "export_mode",
                "value": "",
                "type": "query",
                "description": "export mode (async, sync)"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Export all subscribers as a CSV file."
        },
        {
          "info": {
            "name": "Send SMS to Subscriber by MSISDN",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/msisdn/:msisdn/send_sms",
            "params": [
              {
                "name": "msisdn",
                "value": "",
                "type": "path",
                "description": "MSISDN of the target subscriber."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Send SMS to a subscriber specified with MSISDN."
        },
        {
          "info": {
            "name": "Cancel the transfer of Ready status SIMs (Invalidate the transfer token)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.soracom.io/v1/subscribers/transfer_token/:token",
            "params": [
              {
                "name": "token",
                "value": "",
                "type": "path",
                "description": "Transfer token. The transfer token can be obtained from [Subscriber:issueSubscriberTransferToken](#!/Subscriber/issueSubscriberTransferToken)."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Invalidate the transfer token for SIMs and cancels the transfer of all SIMs associated with the transfer token. To use this API, you need an API key and token issued with the source operator."
        },
        {
          "info": {
            "name": "Initiate the transfer of Ready status SIMs (Issue a transfer token)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/transfer_token/issue",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Initiates the transfer of Ready status SIMs. To use this API, you need an API key and token issued with the source operator. When this API is executed, a transfer token is issued and sent to the destination operator via email. For more information about SIM transfers, please refer to [Transferring Ready Status SIMs](/en/docs/air/transfer/#transferring-ready-status-sims).\n\n- To cancel a transfer, cancel each transfer token individually. If there is a possibility of canceling SIMs one by one, spec"
        },
        {
          "info": {
            "name": "Accept the transfer of Ready status SIMs (Verify the transfer token)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.soracom.io/v1/subscribers/transfer_token/verify",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Soracom-API-Key",
              "value": "{{X-Soracom-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Verifies the transfer token for SIMs and accepts the transfer. To use this API, you need an API key and token issued with the destination operator."
        }
      ]
    }
  ],
  "bundled": true
}