List all SIMs

get

https://api.edgeiq.io/api/v1/platform/sims

Returns a paginated list of SIM records accessible to the current user. Supports filtering by ICCID, MSISDN, device, integration, status, and boolean flags. Pass page_meta=true to receive a paginated envelope ({ resources, page, per_page, total }); omit it to receive a plain array.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

Page number for pagination

per_page

integer

1 to 100

Defaults to 20

Number of items per page

iccid_eq

string

Filter SIMs whose ICCID exactly matches the given value.

msisdn_eq

string

Filter SIMs whose MSISDN exactly matches the given value.

device_id_eq

string

Filter SIMs linked to the specified device ID.

integration_id_eq

string

Filter SIMs associated with the specified integration ID.

sim_status_eq

string

Filter SIMs by lifecycle status. Accepts any string value (sim_status is an open field driven by the carrier/CMP).

sim_barred_eq

boolean

Filter SIMs by whether they have been barred by the carrier.

overage_limit_reached_eq

boolean

Filter SIMs by whether they have reached their overage limit.

page_meta

boolean

Defaults to false

Include pagination metadata in response

Responses

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation