View all SIMs

Returns the SIMs on your account, most recent first.

Add one or more query parameters to filter the results. Filters match exactly, and combining filters narrows the results. Omit all filters to return every SIM.

Results are paged. See pageToken and pageSize.

get

Authorizations

AuthorizationstringRequired

An OAuth 2.0 client credentials access token, sent as Authorization: Bearer <token>.

Request the token from https://eseye-idp-prod.auth.eu-west-1.amazoncognito.com/oauth2/token using the client ID and client secret Eseye supplied. Tokens expire after one hour.

Query parameters

iccIdstringOptional

The ICC ID of the SIM. Repeat to fetch several.

Example: 8944500000000000123

simIdstringOptional

The unique identifier for the SIM.

Example: 9445000000000123

iccMnoIdstringOptional

The mobile network operator the SIM belongs to.

Example: 9953

iccSpecIdintegerOptional

The specification the SIM was manufactured to.

Example: 12345

iccTypeIdintegerOptional

The type of SIM, for example plug-in, embedded, or eSIM.

Example: 123

adminSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
yes	The service or object is disabled.
no	The service or object is not disabled.

Example: noPossible values:

systemSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
yes	The service or object is disabled.
no	The service or object is not disabled.

Example: noPossible values:

customerSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
yes	The service or object is disabled.
no	The service or object is not disabled.

Example: noPossible values:

dataSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
yes	The service or object is disabled.
no	The service or object is not disabled.

Example: noPossible values:

voiceSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
yes	The service or object is disabled.
no	The service or object is not disabled.

Example: noPossible values:

messagingSuspendstring · enumOptional

A yes or no flag.

Value	Meaning
yes	The service or object is disabled.
no	The service or object is not disabled.

Example: noPossible values:

eIdstringOptional

The eUICC identifier of the SIM.

Example: 89049032000000000000000000000001

rspIdintegerOptional

The remote SIM provisioning platform the SIM uses.

Example: 78901

statusstring · enumOptional

The status of the SIM.

Value	Meaning
available	The SIM exists on your account and has a package, but cannot connect to a network. No service charges apply.
active	The SIM is provisioned and ready to use on the network. Standard service charges and usage charges apply.

Set status to active to activate a SIM, or to available to deactivate it.

Example: activePossible values:

packageIdintegerOptional

The package applied to the SIM.

Example: 20888

portfolioIdstringOptional

The portfolio the SIM is assigned to.

Example: a628ebc659f7dac01f9fdcbd1116307a

platformIdintegerOptional

The platform the SIM is provisioned on.

pin1stringOptional

The first PIN for the SIM.

pin2stringOptional

The second PIN for the SIM.

puk1stringOptional

The first PUK code for the SIM.

puk2stringOptional

The second PUK code for the SIM.

activatedDatestring · date-timeOptional

The date the SIM was activated.

Example: 2023-06-28T05:52:03Z

terminatedDatestring · date-timeOptional

The date the SIM was terminated.

pageTokenstringOptional

Token for fetching the next page. Omit it for the first page, then pass the nextPageToken from the previous response.

Example: 0

pageSizeinteger · min: 1 · max: 300Optional

The maximum number of results per page. The default is 50.

Example: 50

Responses

200

A paginated list of SIMs.

application/json

The pagination envelope returned by list endpoints.

pageTokenstringOptional

Identifier of the current page of results.

Example: 0

nextPageTokenstringOptional

Pass this back as pageToken to fetch the next page. Only returned when more results exist.

Example: 50

requestedPageSizeintegerOptional

The page size applied to this request.

Example: 50

itemCountintegerOptional

The number of items returned in this page.

Example: 13

400

The request contained an invalid parameter. additionalDetails lists the fields that failed validation.

application/json

403

The token is valid, but the service account does not have permission for this operation.

application/json

404

An entity referenced in the request does not exist. The message and additionalDetails name what could not be resolved.

application/json

get/api/v2/sim

GET /api/v2/sim HTTP/1.1
Host: sim.api.anynetiot.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "pageToken": "0",
  "nextPageToken": "50",
  "requestedPageSize": 50,
  "itemCount": 50,
  "items": [
    {
      "iccId": "8944500000000000123",
      "simId": "9445000000000123",
      "iccMnoId": "9953",
      "iccSpecId": 5215,
      "iccTypeId": 152,
      "adminSuspend": "no",
      "systemSuspend": "no",
      "customerSuspend": "no",
      "dataSuspend": "no",
      "messagingSuspend": "no",
      "voiceSuspend": "no",
      "eId": "89049032000000000000000000000001",
      "pin1": null,
      "pin2": null,
      "puk1": null,
      "puk2": null,
      "platformId": 1,
      "terminatedDate": null,
      "status": "active",
      "activatedDate": "2023-09-27T11:21:14Z",
      "attributes": [
        {
          "iccAttributeId": 27076236,
          "iccId": "8944500000000000123",
          "attribute": "siteRef",
          "value": "532",
          "status": "active"
        },
        {
          "iccAttributeId": 27076229,
          "iccId": "8944500000000000123",
          "attribute": "deviceProfileId",
          "value": "3352",
          "status": "active"
        }
      ]
    }
  ]
}