List all Devices

get

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

List all Devices

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

software_version_in

string

A software version filter in the form <package>[:<operator><version>]. Supported operators include: =, >, >=, <, <=. Multiple parameters can be provided to filter by several packages.

with_sims

boolean

When true, each device in the response will include a latest_sim field containing the most recently updated SIM associated with that device. If a device has no SIMs, the field is omitted.

sims_sim_status

string

Filter devices by SIM status. Accepts a single value or multiple values separated by | for OR matching (e.g. Active|Suspended). Matched case-insensitively against the sim_status column.

sims_rate_plan

string

Filter devices whose SIM matches the given rate plan name. Matched case-insensitively.

sims_communication_plan

string

Filter devices whose SIM matches the given communication plan name. Matched case-insensitively.

sims_overage_limit_reached

boolean

Filter devices by whether their SIM has reached the overage limit. Accepted values: true, false.

sims_ctd_data_usage_gte

number

Filter devices whose SIM has cycle-to-date data usage greater than or equal to the given value (in MB).

sims_ctd_data_usage_lte

number

Filter devices whose SIM has cycle-to-date data usage less than or equal to the given value (in MB).

sims_updated_at_gte

date-time

Filter devices whose SIM was last updated at or after the given ISO 8601 timestamp (e.g. 2026-01-01T00:00:00.000Z).

sims_updated_at_lte

date-time

Filter devices whose SIM was last updated at or before the given ISO 8601 timestamp (e.g. 2026-01-31T23:59:59.999Z).

sims_sim_metadata.*

string

Filter devices by a specific SIM metadata key. Replace * with the metadata key name (e.g. sims_sim_metadata.region). Matched case-insensitively against the JSONB sim_metadata column.

Responses

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

200Successful operation