List SIMs

Returns a list of SIMs filtered, sorted, and paged according to query parameters.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Query parameters

qstringOptionalformat: "(id|issuer_org|reseller_org|customer_org|iccid|iccid_with_luhn|status|production_date|imsi|msisdn|endpoint|model|eid):.+"
Filter parameter in `<field>:<criteria>` format. Expects a comma-separated list from the allowed fields: * `id` * `issuer_org` * `reseller_org` * `customer_org` * `iccid` * `iccid_with_luhn` * `status` * `production_date` * `imsi` * `msisdn` * `endpoint` * `model` * `eid` * `satellite_capable`
sortstringOptionalformat: "(^-?(id|issuer_org|reseller_org|customer_org|iccid|eid|status|production_date|endpoint|model)),?"
Sort parameter in `<operator><field>` format. Sort properties according to a comma-separated list from the allowed fields: * `id` * `issuer_org` * `reseller_org` * `customer_org` * `iccid` * `eid` * `status` * `production_date` * `endpoint` * `model` If no sorting options are specified, the response will be sorted by `id`. Supported operators: * `-`: Descending order * `+`: Ascending order The response will be shown in ascending order if no operator is specified.
pageintegerOptional
Current page number
per_pageintegerOptional1-2500Defaults to 2000

Defines the number of items per page (max. 2500)

Response

Successfully returned a list of SIMs.
idinteger or null
iccidstring or null
eidstring or null
production_datestring or nullformat: "date-time"
activation_datestring or nullformat: "date-time"
statusobject or null
customer_orgobject or null
issuer_orgobject or null
reseller_orgobject or null
endpointobject or null
imsistring or null
msisdnstring or null
modelobject or null