List SIMs | emnify Documentation

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

[
  {
    "id": 788,
    "iccid": "7368267364738297736",
    "eid": "89049011803455664400046832584675",
    "production_date": "2019-08-01T11:49:46.000+0000",
    "activation_date": "2019-08-21T18:49:46.000+0000",
    "status": {
      "id": 1,
      "description": "Activated"
    },
    "customer_org": {
      "id": 13,
      "name": "Enterprise",
      "country": {
        "id": 205,
        "name": "United Kingdom"
      }
    },
    "issuer_org": {
      "id": 11,
      "name": "MNO",
      "country": {
        "id": 205,
        "name": "United Kingdom"
      }
    },
    "endpoint": {
      "id": 1
    },
    "imsi": "123451234567890",
    "msisdn": "88563748761",
    "model": {
      "id": 1,
      "description": "Java smartcard",
      "memory_size": 64,
      "formfactor": {
        "id": 1,
        "name": "2FF"
      },
      "manufacturer": {
        "id": 1,
        "name": "Motorola"
      }
    }
  },
  {
    "id": 123456,
    "iccid": "8988303000123456789",
    "production_date": "2019-03-02T11:22:29.000+0000",
    "status": {
      "id": 1,
      "description": "Activated"
    },
    "customer_org": {
      "id": 1234,
      "name": "Example Organization",
      "country": {
        "id": 74,
        "name": "Germany"
      }
    },
    "issuer_org": {
      "id": 2,
      "name": "Example Issuer",
      "country": {
        "id": 219,
        "name": "NonTerrestrial 883"
      }
    },
    "endpoint": {
      "id": 12345
    },
    "imsi": "123456789123456",
    "msisdn": "12345678912",
    "model": {
      "id": 8,
      "description": "Classic",
      "memory_size": 64,
      "formfactor": {
        "id": 6,
        "name": "1/2/3FF (3in1)"
      },
      "manufacturer": {
        "id": 5,
        "name": "Oberthur"
      }
    }
  },
  {
    "id": 123457,
    "iccid": "1234512345000001234",
    "eid": "89049011803455664400011562584675",
    "production_date": "2019-03-02T11:22:29.000+0000",
    "status": {
      "id": 1,
      "description": "Activated"
    },
    "customer_org": {
      "id": 1234,
      "name": "Example Organization",
      "country": {
        "id": 74,
        "name": "Germany"
      }
    },
    "issuer_org": {
      "id": 2,
      "name": "Example Issuer",
      "country": {
        "id": 219,
        "name": "NonTerrestrial 883"
      }
    },
    "endpoint": {
      "id": 12345
    },
    "imsi": "123456789123456",
    "msisdn": "12345678912",
    "model": {
      "id": 8,
      "description": "Classic",
      "memory_size": 64,
      "formfactor": {
        "id": 6,
        "name": "1/2/3FF (3in1)"
      },
      "manufacturer": {
        "id": 5,
        "name": "Oberthur"
      }
    }
  }
]

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 POST request to /api/v1/authenticate.

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 headers

Linkstring or null

Navigational link URLs to retrieve the first, previous, next, and last page in a dataset.

X-Count-Per-Pageinteger

Number of items to show per page requested via the per_page parameter.

X-Current-Pageinteger

Current page number within the current data set.

X-Total-Countinteger

Total element count in the current data set.

X-Total-Pagesinteger

Total page count in the current data set.

X-Filterstring or null

Returns the relevant values if filtering is applied using ?q=field:criteria query parameter.

X-Sortstring or null

Returns the sorted data set if sorting is applied using ?sort=field query parameter.

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