List SIMs | emnify Documentation

1 curl -G https://cdn.emnify.net/api/v1/sim \ 2 -H "Authorization: Bearer <token>" \ 3 -d q= \ 4 -d sort=

1 [ 2 { 3 "id": 123457, 4 "iccid": "8988303000123456789", 5 "eid": "89049011803455664400046832584675", 6 "production_date": "2019-08-01T11:49:46.000+0000", 7 "status": { 8 "id": 1, 9 "description": "Activated" 10 }, 11 "customer_org": { 12 "id": 1234, 13 "name": "Example Organization", 14 "country": { 15 "id": 74, 16 "name": "Germany" 17 } 18 }, 19 "issuer_org": { 20 "id": 2, 21 "name": "Example Issuer", 22 "country": { 23 "id": 219, 24 "name": "NonTerrestrial 883" 25 } 26 }, 27 "endpoint": { 28 "id": 12345, 29 "name": "endpoint 2", 30 "imei": {}, 31 "imei_with_luhn": {}, 32 "created": "2019-12-11T10:37:34.000+0000", 33 "last_updated": "2019-12-11T10:37:34.000+0000", 34 "organisation_id": 1234, 35 "service_profile_id": 12345, 36 "tariff_profile_id": 12345, 37 "tags": {}, 38 "ip_address": "10.1.1.2", 39 "ip_address_space_id": 123 40 }, 41 "imsi": "123456789123456", 42 "msisdn": "12345678912", 43 "model": { 44 "id": 8, 45 "description": "Classic", 46 "memory_size": 64, 47 "formfactor": { 48 "id": 6, 49 "name": "1/2/3FF (3in1)" 50 }, 51 "manufacturer": { 52 "id": 5, 53 "name": "Oberthur" 54 } 55 }, 56 "iccid_with_luhn": "89883030001234567890", 57 "profile_type": { 58 "id": 1, 59 "description": "UICC" 60 } 61 } 62 ]

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

qstringOptional

format: "(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

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`

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.

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