HOhologram
SIMs (Devices)

List SIMs (devices)

Retrieve a list of SIMs (devices) with their detailed information including profile information (cellular links), session data, and metadata. SIMs are returned sorted by creation date, with the most recent SIMs appearing first. Use the limit and startafter parameters together for cursor-based pagination through large SIM lists.

get/devices

Request

Query parameters

orgidinteger

Filter results to this organization ID

limitinteger
Example:50

Maximum number of results to return (max 5000)

startafterinteger

Return results after the record with this ID (cursor-based pagination)

slimboolean

When set to 1, return a compact response with fewer fields

withlocationboolean

When true, include last known location data in each SIM record (default: true)

statesstring

Comma-separated list of SIM states to filter by (e.g. LIVE,PAUSED-USER,CONNECTED)

idsstring

Comma-separated list of device IDs to filter by

tagidinteger

Filter results to SIMs with this tag ID

tagidsstring

Comma-separated list of tag IDs to filter by

tagnamestring

Filter results to SIMs with this tag name

namestring

Filter results to SIMs matching this exact name

imeistring

Filter results to devices with this IMEI

linkidinteger

Filter results to devices with this cellular link ID

linkidsstring

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

planidinteger

Filter results to SIMs subscribed to this data plan ID

iccidstring

Filter results to SIM profiles with this ICCID

iccidsstring

Comma-separated list of ICCIDs to filter by

simstring

Alias for iccid — filter results to devices with this ICCID

simsstring

Alias for iccids — comma-separated list of ICCIDs to filter by

imsistring

Filter results to SIM profiles with this IMSI

msisdnstring

Filter results to devices with this MSISDN

simcardidinteger

Filter results to devices with this SIM card ID

eidstring

Filter results to SIMs with this EID

eidsstring

Comma-separated list of EIDs to filter by

eidrangestring

Filter by EID range in "start-end" format

showHiddeninteger

When true, include hidden devices in results

phonestring

Filter results to SIMs with this phone number

tunnelableinteger

Filter results to SIMs with this tunnelable flag value

Response

OK

successboolean

Indicates whether the request was successful.

limitinteger
sizeinteger
continuesboolean
lastidinteger

ID of the last record returned, for cursor-based pagination

Example response

{
  "success": true
}

Changes

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