List SIMs

GET

https://cdn.emnify.net/api/v1/sim

GET

/api/v1/sim

$ curl https://cdn.emnify.net/api/v1/sim \
>      -H "Authorization: Bearer <token>"

200Default - List All SIMs

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       "tags": null,
31       "ip_address": "10.1.1.2"
32     },
33     "imsi": "123456789123456",
34     "msisdn": "12345678912",
35     "model": {
36       "id": 8,
37       "description": "Classic",
38       "formfactor": {
39         "id": 6,
40         "name": "1/2/3FF (3in1)"
41       }
42     },
43     "iccid_with_luhn": "89883030001234567890"
44   }
45 ]

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`

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

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

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

X-Sortstring

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

Response

Successfully returned a list of SIMs.

idinteger

iccidstring

eidstring

production_datestringformat: "date-time"

activation_datestringformat: "date-time"

statusobject

customer_orgobject

issuer_orgobject

reseller_orgobject

endpointobject

imsistring

msisdnstring

modelobject

$	curl https://cdn.emnify.net/api/v1/sim \
>	-H "Authorization: Bearer <token>"

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	"tags": null,
31	"ip_address": "10.1.1.2"
32	},
33	"imsi": "123456789123456",
34	"msisdn": "12345678912",
35	"model": {
36	"id": 8,
37	"description": "Classic",
38	"formfactor": {
39	"id": 6,
40	"name": "1/2/3FF (3in1)"
41	}
42	},
43	"iccid_with_luhn": "89883030001234567890"
44	}
45	]