api/v1/sims
Method: GET https://simportal-api-staging.azurewebsites.net/api/v1/sims?search={search}&skip={skip}&take={take}&includeDecommissioned={includeDecommissioned}&sortBy={sortBy}&sortOrder={sortOrder}&state={state}
Summary
Get a list of SIMs for the current reseller
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| search |
Used to find a partial match against mobile number, ICCID, SIM tag, owner email address and owner mobile number. |
string |
None. |
| skip |
The number of records to skip |
integer |
Default value is 0 |
| take |
The number of records requested |
integer |
Default value is 10 |
| includeDecommissioned |
Include sims that are in a Decommissioned State |
boolean |
Default value is False |
| sortBy |
The name of the parameter by which you wish to sort. ICCID is default sort by. Optional |
string |
None. |
| sortOrder |
Enter 'asc' for ascending or 'desc' for descending sort. Ascending is default behaviour. Optional |
string |
Default value is asc |
| state |
The SIM State string to filter to |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of SimModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Allownace | integer |
None. |
|
| Barred | boolean |
None. |
|
| BoltonAllowance | integer |
None. |
|
| ContactEmail | string |
None. |
|
| ContactMobileNumber | string |
None. |
|
| SimTag | string |
None. |
|
| HasBoltons | boolean |
None. |
|
| ICCID | string |
None. |
|
| Id | globally unique identifier |
None. |
|
| MobileNumber | string |
None. |
|
| Operator | string |
None. |
|
| LastSeenCountry | string |
None. |
|
| LastSeenNetwork | string |
None. |
|
| LastSeenAt | date |
None. |
|
| AllowanceUsedPercent | decimal number |
None. |
|
| ActivatedDate | date |
None. |
|
| State | SimState |
None. |
|
| Tariff | string |
None. |
|
| TariffAllowance | integer |
None. |
|
| Usage | integer |
None. |
|
| CustomerId | globally unique identifier |
None. |
|
| QRPayload | string |
None. |
Response Formats
application/json, text/json, application/xml, text/xml
Sample not available.