Lightbug Documentation
Search K

Appearance

Devices with tag​

GET
/users/id/getDevicesByTag

Parameters​

Path Parameters

id*

user id

Typestring
Required
formatJSON

Query Parameters

tag*

Tag to search for in fully qualified key:value format. Example device_type:truck. Partial searches with wildcards may be used, eg device_type:% or device_type:veh_%

Typestring
Required
fields

Optional array of device model fields to return. eg ["id","name"]

Typestring
formatJSON

Responses​

Request was successful
application/json
JSON
[
{
}
]

Samples​

cURL
curl -X GET \
'https://api.lightbug.cloud/api/users/id/getDevicesByTag' \
 -H "Content-Type: application/json"
JavaScript
fetch('https://api.lightbug.cloud/api/users/id/getDevicesByTag', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://api.lightbug.cloud/api/users/id/getDevicesByTag';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://api.lightbug.cloud/api/users/id/getDevicesByTag'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())