Skip to main content
GET
/
devices
List devices
curl --request GET \
  --url https://dashboard.hologram.io/api/1/devices \
  --header 'Authorization: Basic <encoded-value>'
{
  "success": true,
  "limit": 3,
  "size": 3,
  "continues": true,
  "links": {
    "path": "/api/1/devices",
    "base": "dashboard.hologram.io",
    "next": "/api/1/devices?orgid=98765&limit=3&startafter=1234567"
  },
  "lastid": 1234567,
  "data": [
    {
      "id": 1234567,
      "orgid": 98765,
      "name": "Soil Sensor (12345)",
      "type": "Unknown",
      "whencreated": "2025-08-12 17:24:43",
      "phonenumber": "",
      "phonenumber_cost": "0.0000",
      "tunnelable": 0,
      "imei": "123456789012345",
      "imei_sv": "1234567890123460",
      "hidden": 0,
      "simcardid": 4860808,
      "tags": [],
      "preflight_starttime": null,
      "preflight_scheduled_endtime": null,
      "euicc_tested": "",
      "is_hyper": false,
      "model": "Unknown",
      "manufacturer": "Unknown",
      "links": {
        "cellular": [
          {
            "id": 5608542,
            "partnerid": 1,
            "simcardid": 4860808,
            "deviceid": 1234567,
            "sim": "89123400001234567890",
            "imsi": 123456789012345,
            "msisdn": "123456789012345",
            "carrierid": 13,
            "state": "LIVE",
            "whenclaimed": "2025-08-12 17:24:43",
            "whenexpires": "2025-10-11 17:24:43",
            "overagelimit": -1,
            "data_threshold": -1,
            "smslimit": 100,
            "pin": "1234",
            "puk": "1234567890",
            "euicc_type": "UICC",
            "eid": null,
            "profile_state": "ENABLED",
            "apn": "hologram",
            "plan": {
              "id": 2096,
              "zone": "global",
              "name": "Global Standard Flat Rate",
              "data": 0
            },
            "last_network_used": "AT&T Mobility",
            "last_connect_time": "2025-09-17 04:10:28",
            "cur_billing_data_used": 503417039,
            "last_billing_data_used": 2232757289
          }
        ]
      },
      "lastsession": {
        "linkid": 5608542,
        "session_begin": "2025-09-16 22:39:02",
        "session_end": "2025-09-17 04:10:28",
        "bytes": 473682535,
        "imei": "1234567890123456",
        "cellid": 16956425,
        "lac": 1042,
        "radio_access_technology": "LTE",
        "tadig": "USACG",
        "is_reporting_window_with_usage": 0,
        "network_name": "AT&T Mobility",
        "active": false
      }
    },
    {
      "id": 2234567,
      "orgid": 98765,
      "name": "Hotspot Device (54321)",
      "type": "Unknown",
      "whencreated": "2025-07-03 08:10:14",
      "phonenumber": "",
      "phonenumber_cost": "0.0000",
      "tunnelable": 1,
      "imei": "987654321098765",
      "imei_sv": "9876543210987654",
      "hidden": 0,
      "simcardid": 1209200,
      "tags": [
        {
          "id": 49373,
          "name": "Demo Tag"
        }
      ],
      "preflight_starttime": null,
      "preflight_scheduled_endtime": null,
      "euicc_tested": "",
      "is_hyper": true,
      "model": "MR1100",
      "manufacturer": "Netgear Inc",
      "links": {
        "cellular": [
          {
            "id": 4382376,
            "partnerid": 1,
            "simcardid": 1209200,
            "deviceid": 2234567,
            "sim": "89123400001234554321",
            "imsi": 234567890123456,
            "msisdn": "234567890123456",
            "carrierid": 8,
            "state": "LIVE",
            "whenclaimed": "2025-07-03 08:10:14",
            "whenexpires": "2025-10-01 08:10:14",
            "overagelimit": -1,
            "data_threshold": 25000000,
            "smslimit": 100,
            "pin": "5432",
            "puk": "1234567890",
            "euicc_type": "OPERATIONAL",
            "eid": null,
            "profile_state": "ENABLED",
            "apn": "hologram",
            "plan": {
              "id": 2040,
              "zone": "Global",
              "name": "Global Pay as you Go",
              "data": 0
            },
            "last_network_used": "T-Mobile USA, Inc",
            "last_connect_time": "2025-07-08 17:24:41",
            "cur_billing_data_used": 0,
            "last_billing_data_used": 1413197
          }
        ]
      },
      "lastsession": {
        "linkid": 4382376,
        "session_begin": "2025-07-08 14:21:34",
        "session_end": "2025-07-08 17:24:41",
        "bytes": 225874547,
        "imei": "9876543210987654",
        "cellid": 77317129,
        "lac": 17169,
        "radio_access_technology": "LTE",
        "tadig": "USACG",
        "is_reporting_window_with_usage": 0,
        "network_name": "T-Mobile USA, Inc",
        "active": false
      }
    },
    {
      "id": 3334567,
      "orgid": 98765,
      "name": "Sensor Device (98765)",
      "type": "Unknown",
      "whencreated": "2025-05-19 23:41:12",
      "phonenumber": "",
      "phonenumber_cost": "0.0000",
      "tunnelable": 0,
      "imei": "",
      "imei_sv": "",
      "hidden": 0,
      "tags": [
        {
          "id": 18885,
          "name": "Shipping"
        }
      ],
      "links": {
        "cellular": [
          {
            "id": 4382375,
            "sim": "89123400008531138281",
            "imsi": 0,
            "msisdn": "00",
            "carrierid": 12,
            "state": "DEAD",
            "whenclaimed": "2023-01-06 21:35:04",
            "whenexpires": "2023-02-05 21:35:04",
            "overagelimit": -1,
            "data_threshold": -1,
            "smslimit": -1,
            "pin": "",
            "puk": "",
            "apn": "hologram",
            "plan": {
              "id": 1099,
              "zone": "canada_usa",
              "name": "Canada and USA only - Low usage",
              "data": 0,
              "cost": "0.7000",
              "sms": "0.1900",
              "overage": "0.5000",
              "account_tier": "BASE"
            },
            "last_network_used": "",
            "last_connect_time": "",
            "cur_billing_data_used": 0,
            "last_billing_data_used": 0
          }
        ]
      }
    },
    {
      "id": 2048742,
      "orgid": 52390,
      "name": "Unnamed Device (42670)",
      "type": "Unknown",
      "whencreated": "2022-12-22 01:21:39",
      "phonenumber": "",
      "phonenumber_cost": "0.0000",
      "tunnelable": 0,
      "imei": "",
      "imei_sv": "",
      "hidden": 0,
      "tags": [
        {
          "id": 18885,
          "name": "Shipping"
        }
      ],
      "links": {
        "cellular": [
          {
            "id": 4359750,
            "sim": "89123400007439442670",
            "imsi": 311270018553027,
            "msisdn": "15216014355",
            "carrierid": 12,
            "state": "DEAD",
            "whenclaimed": "2022-12-22 01:21:39",
            "whenexpires": "2023-01-21 01:21:39",
            "overagelimit": -1,
            "data_threshold": -1,
            "smslimit": -1,
            "pin": "",
            "puk": "",
            "apn": "hologram",
            "plan": {
              "id": 1099,
              "zone": "canada_usa",
              "name": "Canada and USA only - Low usage",
              "data": 0,
              "cost": "0.7000",
              "sms": "0.1900",
              "overage": "0.5000",
              "account_tier": "BASE"
            },
            "last_network_used": "",
            "last_connect_time": "",
            "cur_billing_data_used": 0,
            "last_billing_data_used": 0
          }
        ]
      }
    },
    {
      "id": 1996557,
      "orgid": 52390,
      "name": "Panda mangOH Red (02037)",
      "type": "Unknown",
      "whencreated": "2022-12-02 19:09:59",
      "phonenumber": "",
      "phonenumber_cost": "0.0000",
      "tunnelable": 0,
      "imei": "",
      "imei_sv": "",
      "hidden": 0,
      "tags": [
        {
          "id": 22314,
          "name": "Warehouse Device (41234)"
        }
      ],
      "links": {
        "cellular": [
          {
            "id": 4144300,
            "sim": "89123400000000302037",
            "imsi": 222013421950203,
            "msisdn": "999013421950203",
            "carrierid": 8,
            "state": "LIVE",
            "whenclaimed": "2022-12-02 19:09:59",
            "whenexpires": "2023-01-31 19:09:59",
            "overagelimit": -1,
            "data_threshold": -1,
            "smslimit": -1,
            "pin": "3863",
            "puk": "45125304",
            "apn": "hologram",
            "plan": {
              "id": 125,
              "zone": "1",
              "name": "US T-Mobile Only Flat Rate",
              "data": 0,
              "cost": "0.0001",
              "sms": "0.0001",
              "overage": "0.0001",
              "account_tier": "BASE"
            },
            "last_network_used": "",
            "last_connect_time": "",
            "cur_billing_data_used": 0,
            "last_billing_data_used": 0
          }
        ]
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.hologram.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key.

You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

​
slim
integer

Return only the essential fields.

Example:

1

​
orgid
integer
Example:

144

​
orgids
string

Comma-separated list of organization IDs.

Example:

"85366,85367"

​
id
integer
​
ids
string

Comma-separated list of IDs to filter by.

Example:

"101,102,103"

​
startafter
integer
Example:

102544

​
limit
integer

Maximum number of items to return in a single request. For endpoints that support pagination, use this with corresponding /pages endpoints to manage large result sets.

Example:

50

​
includePricing
integer
Example:

1

​
states
string

Comma-separated list of network states.

Example:

"LIVE, LIVE-PENDING, PAUSED-USER, PAUSED-SYS, PAUSED-PENDING-USER, PAUSED-PENDING-SYS, INACTIVE, TEST-ACTIVATE, TEST-ACTIVATE-PENDING, DEAD, DEAD-PENDING"

​
linkid
number

Single profile (link) ID.

Example:

4567890

​
linkids
string

Comma-separated list of link (profile) IDs.

Example:

"5389720,5608542"

​
imsi
number
​
imsis
string

Comma-separated list of IMSIs to filter by.

Example:

"310410123456789,310410987654321"

​
msisdn
string
​
sim
string

ICCID of a profile.

Example:

89131300001234570000

​
sims
string

Comma-separated list of profile ICCIDs.

Example:

"89131300001234567890,89131300001234567891"

​
simrange
string

Range of profile ICCIDs, separated by a hyphen.

Example:

"89131300001234567890-89131300001234568000"

​
imei
integer

IMEI number of a device. Not always available.

Example:

123456789012345

​
tagid
number

Single tag ID.

Example:

101

​
tagids
string

Comma-separated list of tag IDs.

Example:

"101,102,103"

​
tagname
string

Name of a single tag.

Example:

"Chicago Loop"

​
tunnelable
boolean
​
withlocation
boolean
default:true

When true (the default if omitted), the API may enrich each device’s last session with tower-based latitude/longitude when usage and tower data are available. When false, that location lookup is skipped (session usage fields are still returned where applicable).

​
planid
integer

Restrict results to devices that have a cellular link (profile) on this data plan subscription id (linkscellular.dataplansubscriptionid).

​
planids
integer[]

Same as planid, but accepts multiple data plan subscription ids. A device matches if any of its cellular links use one of the given plans.

Response

200 - application/json

List

​
continues
boolean

Displays if there is another page of results.

Example:

true

​
data
object[]
​
lastid
integer
​
limit
integer

The max number of items to return in a single response

Example:

10

​
size
integer

The number of values returned

Example:

216

​
success
boolean

Whether the request was successful or not

Example:

true

​
links
object

Pagination links for retrieving the next page of results