Skip to main content
POST
/
devices
/
search
Search for devices
curl --request POST \
  --url https://dashboard.hologram.io/api/1/devices/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orgid": 123,
  "limit": 5000
}
'
{
  "success": true,
  "limit": 123,
  "size": 123,
  "continues": true,
  "lastid": 123,
  "links": {
    "path": "<string>",
    "base": "<string>",
    "next": "<string>"
  },
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "orgid": 123,
      "type": "<string>",
      "whencreated": "<string>",
      "tags": [
        "<string>"
      ],
      "links": {
        "cellular": [
          {
            "id": 123,
            "deviceid": 123,
            "orgid": 123,
            "sim": "<string>",
            "msisdn": "<string>",
            "imsi": 123,
            "state": "<string>",
            "apn": "<string>",
            "zone": 123,
            "overagelimit": 123,
            "carrier": 123,
            "whencreated": "<string>",
            "whenexpires": "<string>",
            "async_change_requests": [
              {
                "id": 123,
                "parent_id": 123,
                "orgid": 123,
                "userid": 123,
                "reference_id": 123,
                "start_time": "<string>",
                "update_time": "<string>",
                "metadata": {}
              }
            ]
          }
        ]
      },
      "imei": "<string>",
      "imei_sv": "<string>",
      "phonenumber": "<string>",
      "phonenumber_cost": "<string>",
      "simcardid": 123,
      "euicc_tested": "<string>",
      "is_hyper": true,
      "model": "<string>",
      "manufacturer": "<string>",
      "preflight_starttime": "<string>",
      "preflight_scheduled_endtime": "<string>",
      "async_change_requests": [
        {
          "id": 123,
          "parent_id": 123,
          "orgid": 123,
          "userid": 123,
          "reference_id": 123,
          "start_time": "<string>",
          "update_time": "<string>",
          "metadata": {}
        }
      ]
    }
  ]
}

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.

Body

application/json
orgid
integer

Filter results to this organization ID

limit
integer

Maximum number of results to return (max 10000)

Required range: x <= 10000
Example:

5000

Response

OK

success
boolean

Indicates whether the request was successful.

Example:

true

limit
integer
size
integer
continues
boolean
lastid
integer

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

data
object[]