SIMs (Devices)

List SIMs (paginated)

Retrieve pagination information for SIMs retrieved from /devices for organizations with many SIMs. This endpoint will return empty data if there are fewer SIMs than the limit specified.

get/devices/pages

Request

Base URL
https://dashboard.hologram.io/api/1
Auth
HTTP basic
TypeScript
https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/devices/pages/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

orgidinteger

Filter results to this organization ID

limitinteger

Example:5000

Maximum number of results to return (max 5000)

statesstring

Comma-separated list of network states to filter by.

deviceidsstring

Comma-separated list of device IDs to include

tagidinteger

Filter results to SIMs with this tag ID

tagidsstring

Comma-separated list of tag IDs to filter by

linkidsstring

Comma-separated list of profile cellular link IDs to filter by

simsstring

Comma-separated list of SIM profile ICCIDs to filter by

simrangestring

SIM range to filter by, formatted as start-end

devicesPerPageinteger

Number of results per page; used to compute page boundary IDs. Defaults to limit minus 1 if not provided.

showHiddeninteger

When true, include hidden devices in results

Response

successboolean

Indicates whether the request was successful.

limitinteger

Maximum number of results requested

sizeinteger

Number of page boundaries returned

continuesboolean

Whether more results exist beyond this page

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.