How to filter subscribers by network status
This section provides you with some examples of how to filter your subscribers by network status. The examples include a sample call and its corresponding API query language filter.
You filter subscribers by their network status using the /subscribers endpoint.
The examples show you how to return your company's:
- Active subscribers
- Online subscribers
- Transferring subscribers
- Terminated subscribers
- Unattached eSIM profiles
- Attached eSIM profiles
- Enabled eSIM profiles
- Disabled eSIM profiles
- eSIM profiles
Info
You filter the results an endpoint returns using the API query language.
Refer to the Filtering topic for further information.
Subscriber statuses
Subscribers are broken down into the following statuses:
| Status | Description |
|---|---|
| Active | Subscribers that can connect to the network and are included as part of the account's invoice. |
| Online | Subscribers that are currently connected to the network. |
| Offline | Subscribers that are active but are not currently connected to the network. |
| Transferring | Subscribers that are currently sending or receiving data. |
| Terminated | Subscribers that have been terminated and cannot access the platform. |
Filtering active subscribers
For your company, this call returns every active subscriber.
| Example Call |
|---|
curl -X GET "https://api.iot-x.com/subscribers?isActive eq "true" -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| isActive eq "true" |
Filtering online subscribers
For your company, this call returns every online subscriber.
| Example Call |
|---|
curl -X GET "https://api.iot-x.com/subscribers?isOnline eq "true" -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| isOnline eq "true" |
Filtering offline subscribers
For your company, this call returns every offline subscriber.
| Example Call |
|---|
curl -X GET "https://api.iot-x.com/subscribers?isOnline eq "false" -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| isOnline eq "false" |
Filtering transferring subscribers
For your company, this call returns every transferring subscriber.
| Example Call |
|---|
curl -X GET "https://api.iot-x.com/subscribers?isTransferring eq "true" -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| isTransferring eq "true" |
Filtering terminated subscribers
For your company, this call returns every terminated subscriber.
| Example Call |
|---|
curl -X GET "https://api.iot-x.com/subscribers?isActive eq "false" -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| isActive eq "false" |
Filtering unattached eSIM profiles
For your company, this call returns every eSIM profile that is not attached to an eUICC SIM card.
| Example Call |
|---|
curl -X GET "https://api.iot-x.com/subscribers?filter=parentPhysicalId is "null" and subscriberType eq "virtual%22" -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| parentPhysicalId is "null" and subscriberType eq "virtual" |
Filtering attached eSIM profiles
For your company, this call returns every eSIM profile that is attached to an eUICC card.
| Example Call |
|---|
curl -X GET "https://api.iot-x.com/subscribers?filter=parentPhysicalId is "8944000000000000001" and subscriberType eq "virtual" -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| physicalId is "<IMEI of the eUICC SIM>" and subscriberType eq "virtual" |
Filtering enabled eSIM profiles
For your company, this call returns every enabled eSIM profile.
| Example Call |
|---|
curl -X GET "https://api.iot-x.com/subscribers?filter=subscriberType eq "virtual" and isEnabledOnParent eq "true" -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| subscriberType eq "virtual" and isEnabledOnParent eq "true" |
Filtering disabled eSIM profiles
For your company, this call returns every disabled eSIM profile.
| Filtering Disabled eSIM Profiles |
|---|
curl -X GET "https://api.iot-x.com/subscribers?filter=subscriberType eq "virtual" and isEnabledOnParent eq "false" -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| subscriberType eq "virtual" and isEnabledOnParent eq "false" |
Filtering all eSIM profiles
For your company, this call returns every eSIM profile.
| Example Call |
|---|
curl -X GET "https://api.iot-x.com/subscribers?filter=subscriberType eq "virtual" and (isEnabledOnParent eq "true" or isEnabledonParent eq "false") -H "Authorization: Bearer <Your Access Token>" -H "accept: application/json" |
| API Query Language Filter |
|---|
| subscriberType eq "virtual" and (isEnabledOnParent eq "true" or isEnabledOnParent eq "false") |