GET /api/v3/campaigns/{lcuid}/digital-boards¶
Summary¶
GET campaigns/{lcuid}/digital-boards
Description¶
Get a list of digital boards that are currently attached to this campaign. See Digital Board for details on the digital board object
Tags: campaigns
Parameters¶
Query Parameters¶
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
agency_id |
integer |
✓ Yes | Filter by the board's agency ID. | `` |
board_identifier |
string |
✓ Yes | Filter by a partial board identifier. | `` |
venue_taxonomy_id |
integer |
✓ Yes | Filter by venue taxonomy ID. | `` |
digital_board_format |
string |
✓ Yes | Filter by digital board format. | `` |
page |
integer |
✓ Yes | Page number (minimum 1). | 1 |
per_page |
integer |
✓ Yes | Boards per page (default 100, minimum 1). | 100 |
default_creative_running |
integer |
✓ Yes | 1 for boards without non-default running items, 0 otherwise. | `` |
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-********-****-****-****-************ |
Request Body¶
Content Type: application/json¶
Schema¶
Type: object
Properties:
agency_id(integer)board_identifier(string)venue_taxonomy_id(integer)digital_board_format(string)page(integer): Must be at least 1.per_page(integer): Must be at least 1.default_creative_running(string): Must be one of0or1.
Responses¶
Response: 200¶
Description: Sample Response
Content Type: application/json¶
Schema¶
Type: object
Properties:
success(boolean)digital_boards(array): The array of digital boards on the current page-
Array items:
objectType:objectProperties:
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(integer)board_class(string)hash_id(string)creative_width(integer)creative_height(integer)creative_is_upscaled(boolean)digital_board_format(object) Type:object
Properties:
code(string)name(string)width(integer)height(integer)min_ratio(number)max_ratio(number)-
meta(array) -
location(object) Type:object
Properties:
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:objectProperties:
_init(array)
-
location_class(string) lcuid(string)street_view_status(string)heading(string)pitch(string)zoom(string)hash_id(string)lid(string)parent_id(integer)parent_type(string)created_at(string)updated_at(string)location_class_description(string)-
fov(integer) -
street_view_location(string) board_class_description(string)board_size_description(string)options(object) Type:object
Properties:
primary_image_public_url(string)slot_count(string)slot_length(string)impressions_calc_method(string)avg_daily_impressions(string)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 transact_channel_class_description(string)media_type_class(array)- Array items:
string media_type_class_description(string)aspect_ratio(string)latitude(string)longitude(string)cached_tags(string)
-
pagination(object) Type:object
Properties:
current_page(integer): The current page numberfrom(integer)last_page(integer): The last page number-
links(array)- Array items:
objectType:object
Properties:
url(string)label(string)active(boolean)
- Array items:
-
per_page(integer): The number of boards per page to(integer)total(integer): The total number of matching digital boards
Example Response¶
{
"success": true,
"digital_boards": [
{
"board_identifier": "fduxrbv",
"name": "Unit Test - qbGccx53VHyDbmw",
"status": 1,
"created_at": "2026-10-09T13:49:30.000000Z",
"updated_at": "2026-10-09T13:49:30.000000Z",
"network": 0,
"width": 1400,
"height": 400,
"hardware_provider": "unit_test_hardware",
"software_provider": "unit_test_software_provider",
"description": null,
"street_view_status": null,
"street_view_review_status": 0,
"xr_status": 0,
"venue_taxonomy_id": 301,
"board_class": "App\\LuCore\\DigitalBoards\\DigitalBillboardBoardClass",
"hash_id": "lch-4Lzv",
"creative_width": 1400,
"creative_height": 400,
"creative_is_upscaled": false,
"digital_board_format": {
"code": "bulletin",
"name": "Bulletin",
"width": 1400,
"height": 400,
"min_ratio": 3.2666,
"max_ratio": 3.717,
"meta": []
},
"location": {
"name": "Unit Test - LGb7GR18PjpgtXv",
"description": "Unit Test Description - wys0PVaiLemyrwOVSVijZKDz8gGCD8SG2OSncrmUms1yAlzeEfUhTpx9V7eFUqVWC3jWNRfPoodAX2cCP6BuNejwRZDztLkSlCQ97K2C211zurZu5uUbxlrVEZFKuzJvzr00OHmOxb5xvDbAiPBv07",
"phone": "+18727942441",
"address": "989 O'Conner Locks",
"city": "North Erika",
"region": "Vermont",
"postal_code": "37414-5960",
"country": "US",
"latitude": "26.78959600000000",
"longitude": "-110.80642200000000",
"location_default": 1,
"status": 1,
"options": {
"_init": []
},
"location_class": "App\\LuCore\\Locations\\GenericLocationClass",
"lcuid": "LCUID-LL-1e3f374b-36ce-421f-991e-31b6a93e5557",
"street_view_status": null,
"heading": null,
"pitch": null,
"zoom": null,
"hash_id": "lch-4HsJ",
"lid": "LL22027",
"parent_id": 37875,
"parent_type": "App\\DigitalBoard",
"created_at": "2026-10-09T13:49:30.000000Z",
"updated_at": "2026-10-09T13:49:30.000000Z",
"location_class_description": "Generic Location",
"fov": 1
},
"street_view_location": null,
"board_class_description": "Digital Billboard",
"board_size_description": "1400x400",
"options": {
"primary_image_public_url": null,
"slot_count": null,
"slot_length": null,
"impressions_calc_method": null,
"avg_daily_impressions": null,
"facing_degrees": null,
"facing_cardinal": null,
"read": null,
"pending_xr_image_url": null
},
"lcuid": "LCUID-LB-8bbdcf01-4001-4ce3-a2a6-22bed6ed0544",
"slug": "TestAgencyUnitTest5bbqmBoardFduxrbv",
"address": "989 O'Conner Locks",
"city": "North Erika",
"region": "Vermont",
"postal_code": "37414-5960",
"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": "3.50000000",
"latitude": "26.78959600",
"longitude": "-110.80642200",
"cached_tags": null
},
{
"board_identifier": "rwk9dos",
"name": "Unit Test - 2Y5woGj92TPEexj",
"status": 1,
"created_at": "2026-10-09T13:49:31.000000Z",
"updated_at": "2026-10-09T13:49:31.000000Z",
"network": 0,
"width": 1400,
"height": 400,
"hardware_provider": "unit_test_hardware",
"software_provider": "unit_test_software_provider",
"description": null,
"street_view_status": null,
"street_view_review_status": 0,
"xr_status": 0,
"venue_taxonomy_id": 301,
"board_class": "App\\LuCore\\DigitalBoards\\DigitalBillboardBoardClass",
"hash_id": "lch-4Lzw",
"creative_width": 1400,
"creative_height": 400,
"creative_is_upscaled": false,
"digital_board_format": {
"code": "bulletin",
"name": "Bulletin",
"width": 1400,
"height": 400,
"min_ratio": 3.2666,
"max_ratio": 3.717,
"meta": []
},
"location": {
"name": "Unit Test - YqDuav3HAfJxwLd",
"description": "Unit Test Description - LbdpxXPxui20s18B3muC4Rn6rUk44CUiupKmZu8C1KOIvJANYbhC90n80iPstQ1C0X7iTv9laisyYcOTZuNynnHhrXCtWMAvn0MtEtFubmcgatt0hydo8nmBXB9XRNCiqUU2Nzz9MresG34QKOiI3X",
"phone": "+1 (657) 986-6063",
"address": "65169 Wiegand Pike Apt. 726",
"city": "Port Alfredo",
"region": "North Dakota",
"postal_code": "19214-9996",
"country": "US",
"latitude": "31.87140800000000",
"longitude": "-122.96249000000000",
"location_default": 1,
"status": 1,
"options": {
"_init": []
},
"location_class": "App\\LuCore\\Locations\\GenericLocationClass",
"lcuid": "LCUID-LL-dadf63ca-28a0-420a-9a69-a5cc64346f72",
"street_view_status": null,
"heading": null,
"pitch": null,
"zoom": null,
"hash_id": "lch-4HsK",
"lid": "LL22028",
"parent_id": 37876,
"parent_type": "App\\DigitalBoard",
"created_at": "2026-10-09T13:49:31.000000Z",
"updated_at": "2026-10-09T13:49:31.000000Z",
"location_class_description": "Generic Location",
"fov": 1
},
"street_view_location": null,
"board_class_description": "Digital Billboard",
"board_size_description": "1400x400",
"options": {
"primary_image_public_url": null,
"slot_count": null,
"slot_length": null,
"impressions_calc_method": null,
"avg_daily_impressions": null,
"facing_degrees": null,
"facing_cardinal": null,
"read": null,
"pending_xr_image_url": null
},
"lcuid": "LCUID-LB-c0abda98-e96a-4a76-a3f0-cc027d03e30a",
"slug": "TestAgencyUnitTest5bbqmBoardRwk9dos",
"address": "65169 Wiegand Pike Apt. 726",
"city": "Port Alfredo",
"region": "North Dakota",
"postal_code": "19214-9996",
"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": "3.50000000",
"latitude": "31.87140800",
"longitude": "-122.96249000",
"cached_tags": null
},
{
"board_identifier": "t5td5ka",
"name": "Unit Test - jai7eUGVVtSlQzQ",
"status": 1,
"created_at": "2026-10-09T13:49:29.000000Z",
"updated_at": "2026-10-09T13:49:29.000000Z",
"network": 0,
"width": 1400,
"height": 400,
"hardware_provider": "unit_test_hardware",
"software_provider": "unit_test_software_provider",
"description": null,
"street_view_status": null,
"street_view_review_status": 0,
"xr_status": 0,
"venue_taxonomy_id": 301,
"board_class": "App\\LuCore\\DigitalBoards\\DigitalBillboardBoardClass",
"hash_id": "lch-4Lzu",
"creative_width": 1400,
"creative_height": 400,
"creative_is_upscaled": false,
"digital_board_format": {
"code": "bulletin",
"name": "Bulletin",
"width": 1400,
"height": 400,
"min_ratio": 3.2666,
"max_ratio": 3.717,
"meta": []
},
"location": {
"name": "Unit Test - kkhGGsrSFLUbjCQ",
"description": "Unit Test Description - cL4lkLdZiRjSPGQinLBXLSeWbFeGA8L2pDrgwDAlyvajwOp0P4q0uz2e5WLGNOQ2SeOy0T1TrLaVl3HLXk54q7zjugleOubxITqHMijTS9exd11gqcthjzsHTuYowWGevvHT6lAuwMZyljoHIxyL7F",
"phone": "+1.847.445.6089",
"address": "63977 Kutch Loaf",
"city": "Schimmelberg",
"region": "Mississippi",
"postal_code": "22525",
"country": "US",
"latitude": "32.04415500000000",
"longitude": "-104.95461800000000",
"location_default": 1,
"status": 1,
"options": {
"_init": []
},
"location_class": "App\\LuCore\\Locations\\GenericLocationClass",
"lcuid": "LCUID-LL-d0477055-6499-4a57-851c-5865ef14070e",
"street_view_status": null,
"heading": null,
"pitch": null,
"zoom": null,
"hash_id": "lch-4HsI",
"lid": "LL22026",
"parent_id": 37874,
"parent_type": "App\\DigitalBoard",
"created_at": "2026-10-09T13:49:29.000000Z",
"updated_at": "2026-10-09T13:49:29.000000Z",
"location_class_description": "Generic Location",
"fov": 1
},
"street_view_location": null,
"board_class_description": "Digital Billboard",
"board_size_description": "1400x400",
"options": {
"primary_image_public_url": null,
"slot_count": null,
"slot_length": null,
"impressions_calc_method": null,
"avg_daily_impressions": null,
"facing_degrees": null,
"facing_cardinal": null,
"read": null,
"pending_xr_image_url": null
},
"lcuid": "LCUID-LB-ee4ea5ad-e91e-4eac-a87c-f16a4b5add83",
"slug": "TestAgencyUnitTest5bbqmBoardT5td5ka",
"address": "63977 Kutch Loaf",
"city": "Schimmelberg",
"region": "Mississippi",
"postal_code": "22525",
"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": "3.50000000",
"latitude": "32.04415500",
"longitude": "-104.95461800",
"cached_tags": null
}
],
"pagination": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://localhost:8080/api/v3/campaigns/LCUID-LE-e7c287a2-3530-4a5d-be97-71a02ac5b6da/digital-boards?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"per_page": 100,
"to": 3,
"total": 3
}
}
Example Implementations¶
JavaScript (Fetch API)¶
const url = new URL(
"https://api.lucit.app/api/v3/campaigns/LCUID-LE-506fc585-77be-11ec-acb9-c2cdb617d190/digital-boards"
);
const params = {
"page": "1",
"per_page": "100",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {AuthToken}",
"Content-Type": "application/json",
"Accept": "application/json",
"AppIdV3": "LCUID-LAP-********-****-****-****-************",
};
let body = {
"agency_id": 8,
"board_identifier": "aliquid",
"venue_taxonomy_id": 8,
"digital_board_format": "aliquid",
"page": 72,
"per_page": 11,
"default_creative_running": "0"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());
PHP (Guzzle)¶
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://api.lucit.app/api/v3/campaigns/LCUID-LE-506fc585-77be-11ec-acb9-c2cdb617d190/digital-boards',
[
'headers' => [
'Authorization' => 'Bearer {AuthToken}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
],
'query' => [
'page'=> '1',
'per_page'=> '100',
],
'json' => [
'agency_id' => 8,
'board_identifier' => 'aliquid',
'venue_taxonomy_id' => 8,
'digital_board_format' => 'aliquid',
'page' => 72,
'per_page' => 11,
'default_creative_running' => '0',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
Python (Requests)¶
import requests
import json
url = 'https://api.lucit.app/api/v3/campaigns/LCUID-LE-506fc585-77be-11ec-acb9-c2cdb617d190/digital-boards'
payload = {
"agency_id": 8,
"board_identifier": "aliquid",
"venue_taxonomy_id": 8,
"digital_board_format": "aliquid",
"page": 72,
"per_page": 11,
"default_creative_running": "0"
}
params = {
'page': '1',
'per_page': '100',
}
headers = {
'Authorization': 'Bearer {AuthToken}',
'Content-Type': 'application/json',
'Accept': 'application/json',
'AppIdV3': 'LCUID-LAP-********-****-****-****-************'
}
response = requests.request('GET', url, headers=headers, json=payload, params=params)
response.json()