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
}
'import requests
url = "https://dashboard.hologram.io/api/1/devices/search"
payload = {
"orgid": 123,
"limit": 5000
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({orgid: 123, limit: 5000})
};
fetch('https://dashboard.hologram.io/api/1/devices/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://dashboard.hologram.io/api/1/devices/search';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({orgid: 123, limit: 5000})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"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": "INACTIVE",
"profile_state": "AVAILABLE",
"apn": "<string>",
"zone": 123,
"overagelimit": 123,
"carrier": 123,
"whencreated": "<string>",
"whenexpires": "<string>",
"async_change_requests": [
{
"id": 123,
"parent_id": 123,
"orgid": 123,
"userid": 123,
"request_type": "plan_change",
"reference_type": "device",
"reference_id": 123,
"state": "initialized",
"start_time": "<string>",
"update_time": "<string>",
"metadata": {}
}
]
}
]
},
"eid": "<string>",
"imei": "<string>",
"imei_sv": "<string>",
"tunnelable": 0,
"hidden": 0,
"phonenumber": "<string>",
"phonenumber_cost": "<string>",
"simcardid": 123,
"intended_network_state": "INACTIVE",
"intended_plan_id": 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,
"request_type": "plan_change",
"reference_type": "device",
"reference_id": 123,
"state": "initialized",
"start_time": "<string>",
"update_time": "<string>",
"metadata": {}
}
]
}
]
}Devices
Search for devices
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
}
'import requests
url = "https://dashboard.hologram.io/api/1/devices/search"
payload = {
"orgid": 123,
"limit": 5000
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({orgid: 123, limit: 5000})
};
fetch('https://dashboard.hologram.io/api/1/devices/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://dashboard.hologram.io/api/1/devices/search';
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({orgid: 123, limit: 5000})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"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": "INACTIVE",
"profile_state": "AVAILABLE",
"apn": "<string>",
"zone": 123,
"overagelimit": 123,
"carrier": 123,
"whencreated": "<string>",
"whenexpires": "<string>",
"async_change_requests": [
{
"id": 123,
"parent_id": 123,
"orgid": 123,
"userid": 123,
"request_type": "plan_change",
"reference_type": "device",
"reference_id": 123,
"state": "initialized",
"start_time": "<string>",
"update_time": "<string>",
"metadata": {}
}
]
}
]
},
"eid": "<string>",
"imei": "<string>",
"imei_sv": "<string>",
"tunnelable": 0,
"hidden": 0,
"phonenumber": "<string>",
"phonenumber_cost": "<string>",
"simcardid": 123,
"intended_network_state": "INACTIVE",
"intended_plan_id": 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,
"request_type": "plan_change",
"reference_type": "device",
"reference_id": 123,
"state": "initialized",
"start_time": "<string>",
"update_time": "<string>",
"metadata": {}
}
]
}
]
}Authorizations
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
Was this page helpful?
⌘I