GET /api/v3/lightning/devices/{lcuid}¶
Summary¶
GET /lightning/devices/{lcuid}
Description¶
Get information about a lightning device and it's screens
Tags: lightning
Parameters¶
Header Parameters¶
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
Authorization |
string |
✓ Yes | Bearer {AuthToken} |
|
Content-Type |
string |
✓ Yes | application/json |
|
Accept |
string |
✓ Yes | application/json |
|
AppIdV3 |
string |
✓ Yes | LCUID-LAP-********-****-****-****-************ |
Responses¶
Response: 200¶
Description: Sample Response
Content Type: application/json¶
Schema¶
Type: object
Properties:
success(boolean): truelightning_device(object) Type:object
Properties:
name(string): The name of the devicedescription(string)device_number(string): The device numberdevice_request_lcuid(string): The device request lcuiddevice_provided_uuid(string): The device provided uuidstatus(integer): The status of the device-
options(object) Type:objectProperties:
_init(array)
-
latitude(string): The latitude of the device longitude(string): The longitude of the devicewidth(integer): The width of the deviceheight(integer): The height of the devicedigital_board_format(string): The digital board format of the device See Board Formats Note that this is the format for the device screen itself. If the layout has broken this up into multiple smaller screens, then each screen will have a differing formatvenue_taxonomy_id(string): Open ooh Venue Taxonomy Id See OpenOOH Venue Taxonomylcuid(string): The lcuid of the device-
digital_boards(array): The digital boards (screens) attached to this device See Digital Board- Array items:
objectType:object
Properties:
board_identifier(string)name(string)status(integer)created_at(string)updated_at(string)network(integer)width(integer)height(integer)hardware_provider(string)software_provider(string)description(string)street_view_status(string)street_view_review_status(integer)xr_status(integer)venue_taxonomy_id(string)board_class(string)hash_id(string)creative_width(integer)creative_height(integer)creative_is_upscaled(boolean)-
digital_board_format(object) Type:objectProperties:
code(string)name(string)width(integer)height(integer)min_ratio(number)max_ratio(number)meta(array)
-
board_class_description(string) board_size_description(string)-
options(object) Type:objectProperties:
primary_image_public_url(string)slot_count(integer)slot_length(integer)impressions_calc_method(integer)avg_daily_impressions(integer)facing_degrees(string)facing_cardinal(string)read(string)pending_xr_image_url(string)
-
lcuid(string) slug(string)address(string)city(string)region(string)postal_code(string)country(string)transact_channel_class(array)- Array items:
string
- Array items:
transact_channel_class_description(string)media_type_class(array)- Array items:
string
- Array items:
media_type_class_description(string)aspect_ratio(string)latitude(string)longitude(string)cached_tags(string)
- Array items:
-
location(object) Type:objectProperties:
name(string)description(string)phone(string)address(string)city(string)region(string)postal_code(string)country(string)latitude(string)longitude(string)location_default(integer)status(integer)options(object) Type:object
Properties:
-
_init(array) -
location_class(string) lcuid(string)street_view_status(string)heading(string)pitch(string)zoom(string)hash_id(string)lid(string)parent_id(string)parent_type(string)created_at(string)updated_at(string)location_class_description(string)fov(integer)
-
agency(object) Type:objectProperties:
name(string)description(string)software_provider(string)website(string)status(integer)agency_class(string)options(object) Type:object
Properties:
primary_image_public_url(string)support_text(string)-
proof_legal_text(string) -
lcuid(string) slug(string)created_at(string)updated_at(string)agency_class_description(string)
-
lightning_device_layout(object) Type:objectProperties:
id(integer)created_at(string)updated_at(string)deleted_at(string)agency_id(integer)name(string)screen_count(integer)data(object) Type:object
Properties:
-
screens(array)- Array items:
objectType:object
Properties:
code(string)name(string)-
size(object) Type:objectProperties:
width(string)height(string)
-
type(string) -
position(object) Type:objectProperties:
top(string)left(string)
- Array items:
-
is_auto_generated_default(boolean) -
created_by_user_id(integer) is_default(boolean)lcuid(string)hash_id(string)lid(string)
-
vendor_id(string): The vendor id of the device cached_tags(string)
Example Response¶
{
"success": true,
"lightning_device": {
"name": "Back of main dining room screen",
"description": null,
"device_number": "LDN-20909",
"device_request_lcuid": "LCUID-LDR-f964c0c2-c2f1-49ae-8612-142b2b2860e5",
"device_provided_uuid": "XMKaLPPzuhrbr4F4",
"status": 0,
"options": {
"_init": []
},
"latitude": "32.37826700",
"longitude": "-115.61430500",
"width": 1024,
"height": 768,
"digital_board_format": "oddblock",
"venue_taxonomy_id": null,
"lcuid": "LCUID-LD-25afea10-e5b2-4ad4-91f1-d1e4ee3e2c48",
"digital_boards": [
{
"board_identifier": "LDN-20909-screen",
"name": "Back of main dining room screen - Screen",
"status": 1,
"created_at": "2026-01-07T00:15:34.000000Z",
"updated_at": "2026-01-07T00:15:34.000000Z",
"network": 0,
"width": 1024,
"height": 768,
"hardware_provider": "lucit_lightning",
"software_provider": "lucit_lightning",
"description": "",
"street_view_status": null,
"street_view_review_status": 0,
"xr_status": 0,
"venue_taxonomy_id": null,
"board_class": "App\\LuCore\\DigitalBoards\\DigitalBillboardBoardClass",
"hash_id": "lch-4Hse",
"creative_width": 1024,
"creative_height": 768,
"creative_is_upscaled": false,
"digital_board_format": {
"code": "oddblock",
"name": "Wide Block",
"width": 1000,
"height": 833,
"min_ratio": 1.0001,
"max_ratio": 1.3999,
"meta": []
},
"board_class_description": "Digital Billboard",
"board_size_description": "1024x768",
"options": {
"primary_image_public_url": null,
"slot_count": 8,
"slot_length": 8,
"impressions_calc_method": 0,
"avg_daily_impressions": 0,
"facing_degrees": null,
"facing_cardinal": null,
"read": null,
"pending_xr_image_url": null
},
"lcuid": "LCUID-LB-cc3fa72a-7430-41f5-a1b0-910fd8f297c5",
"slug": "BreezyBillboardsBoardLdn20909Screen",
"address": "4640 Janiya Unions",
"city": "Fritzville",
"region": "Louisiana",
"postal_code": "35970-6120",
"country": "US",
"transact_channel_class": [
"App\\LuCore\\DigitalBoards\\TransactChannels\\ContractTransactChannelClass"
],
"transact_channel_class_description": "Contract",
"media_type_class": [
"App\\LuCore\\DigitalBoards\\MediaTypes\\ImageMediaTypeClass"
],
"media_type_class_description": "Image",
"aspect_ratio": "1.33000000",
"latitude": "32.37826700",
"longitude": "-115.61430500",
"cached_tags": null
}
],
"location": {
"name": "Unit Test - 6heefsJSavFVGRt",
"description": "Unit Test Description - 0pAK10bv82PJq3NhDNZU2eKRx3jjWs9hAdGkV6D5QdTAEc6gxjdozl9FP6iEhKwKaS3i5auxehrQbHgtrE5YTZtz7kpgv3bVlevqiwHUO1tBwLThiCJTW14hJpUcgtJxcyozALfhZNEArkxq8q6Csi",
"phone": "+1-820-447-6361",
"address": "4640 Janiya Unions",
"city": "Fritzville",
"region": "Louisiana",
"postal_code": "35970-6120",
"country": "US",
"latitude": "32.37826700000000",
"longitude": "-115.61430500000000",
"location_default": 1,
"status": 1,
"options": {
"_init": []
},
"location_class": "App\\LuCore\\Locations\\LightningDeviceLocationClass",
"lcuid": "LCUID-LL-d8a08ba4-ddde-4aa9-adad-4021fe24a14c",
"street_view_status": null,
"heading": null,
"pitch": null,
"zoom": null,
"hash_id": "lch-4CuG",
"lid": "LL2928",
"parent_id": null,
"parent_type": null,
"created_at": "2026-01-07T00:15:34.000000Z",
"updated_at": "2026-01-07T00:15:34.000000Z",
"location_class_description": "Lightning Screen Device",
"fov": 1
},
"agency": {
"name": "Breezy Billboards",
"description": "Here is a new unit test agency description",
"software_provider": null,
"website": null,
"status": 0,
"agency_class": "App\\LuCore\\Agencies\\OperatorAgencyClass",
"options": {
"primary_image_public_url": null,
"support_text": null,
"proof_legal_text": null
},
"lcuid": "LCUID-LY-c20d963b-e7f8-4b6a-996e-b873ad3fbbd0",
"slug": "TestAgencyUnitTestLqszw",
"created_at": "2026-01-07T00:15:34.000000Z",
"updated_at": "2026-01-07T00:15:34.000000Z",
"agency_class_description": "Operator"
},
"lightning_device_layout": {
"id": 19323,
"created_at": "2026-01-07T00:15:34.000000Z",
"updated_at": "2026-01-07T00:15:34.000000Z",
"deleted_at": null,
"agency_id": 6124,
"name": "Single Screen",
"screen_count": 1,
"data": {
"screens": [
{
"code": "screen",
"name": "Screen",
"size": {
"width": "100%",
"height": "100%"
},
"type": "fixed",
"position": {
"top": "0%",
"left": "0%"
}
}
],
"is_auto_generated_default": true
},
"created_by_user_id": 12,
"is_default": true,
"lcuid": "LCUID-LDL-bccb5677-a395-4404-b070-62a17d7e9ba7",
"hash_id": "lch-4HAh",
"lid": "LDL19323"
},
"vendor_id": null,
"cached_tags": null
}
}
Example Implementations¶
Bash (cURL)¶
curl --request GET \
--url "https://api.lucit.app/api/v3/lightning/devices/{lcuid}" \
--header "Authorization: Bearer {AuthToken}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "AppIdV3: LCUID-LAP-********-****-****-****-************"
JavaScript (Fetch API)¶
const url = "https://api.lucit.app/api/v3/lightning/devices/{lcuid}";
const headers = {
"Authorization": "Bearer {AuthToken}",
"Content-Type": "application/json",
"Accept": "application/json",
"AppIdV3": "LCUID-LAP-********-****-****-****-************"
};
fetch(url, {
method: "GET",
headers: headers
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
PHP (Guzzle)¶
<?php
require_once 'vendor/autoload.php';
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.lucit.app/api/v3/lightning/devices/{lcuid}', [
'headers' => [
'Authorization' => 'Bearer {AuthToken}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
]
]);
$body = $response->getBody();
$data = json_decode($body, true);
print_r($data);
Python (Requests)¶
import requests
import json
url = "https://api.lucit.app/api/v3/lightning/devices/{lcuid}"
headers = {
"Authorization": "Bearer {AuthToken}",
"Content-Type": "application/json",
"Accept": "application/json",
"AppIdV3": "LCUID-LAP-********-****-****-****-************"
}
response = requests.get(url, headers=headers)
print(response.json())