Skip to content

GET /api/v3/digital-boards/{lcuid}

Summary

GET digital-boards/{id}

Description

Return a single digitalBoard

Tags: digital-boards

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): Indicates whether the request was successful or not
  • digital_board (object) Type: object

Properties:

  • board_identifier (string): The unique vendor supplied id / identifer for this board
  • name (string): The name of the digital board
  • status (integer): See Board Status
  • created_at (string): The timestamp indicating when the digital board was created
  • updated_at (string): The timestamp indicating when the digital board was last updated
  • network (integer): If this board is part of a network of multiple faces showing the same content
  • width (integer): The width of the digital board in pixels
  • height (integer): The height of the digital board in pixels
  • hardware_provider (string): See Hardware Providers
  • software_provider (string): See Software Providers
  • description (string): The description of the digital board
  • street_view_status (integer): See Street View Status
  • street_view_review_status (integer): See Street View Review Status
  • xr_status (integer): See XR Status
  • venue_taxonomy_id (integer): The taxonomy ID associated with the venue of the digital board See OpenOOH Venue Taxonomy
  • board_class (string): The class of the digital board
  • hash_id (string): The hash ID
  • creative_width (integer): The width of the creative
  • creative_height (integer): The height of the creative
  • creative_is_upscaled (boolean): Indicates whether the creative is upscaled or not
  • digital_board_format (object) Type: object

    Properties:

    • code (string): The code
    • name (string): The name
    • width (integer): The width
    • height (integer): The height
    • min_ratio (number): The minimum ratio
    • max_ratio (number): The maximum ratio
    • meta (array): Additional meta information about the digital board format
  • agency (object) Type: object

    Properties:

    • 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)
  • 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: 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 (integer)
    • parent_type (string)
    • created_at (string)
    • updated_at (string)
    • location_class_description (string)
    • fov (integer)
  • street_view_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: object

    Properties:

    • _init (array)
    • digital_board_to_image_id (integer)
    • google_street_view_pano_id (string)

    • location_class (string)

    • lcuid (string)
    • street_view_status (integer)
    • 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 (number)
  • open_ooh_venue_taxonomy (object) Type: object

    Properties:

    • name (string)
    • fully_qualified_name (string)
    • description (string)
    • enumeration_id (integer)
    • version (string)
    • child_count (integer)
    • level (integer)
    • level_name (string)
    • parent_id (integer)
    • lcuid (string)
  • digital_board_to_images (array): An array containing information about images

    • Array items: object Type: object

    Properties:

    • name (string)
    • style (string)
    • is_main_image (integer)
    • order_number (integer)
    • lcuid (string)
    • image (string)
    • options (object) Type: object

      Properties:

      • overlay_type (string)
      • dimension_width (integer)
      • dimension_height (integer)
      • overlay_perspective_coordinates (array)
      • Array items: array
      • generic_overlay_image_public_url (string)
  • board_class_description (string): The description of the digital board class

  • board_size_description (string): The description of the size of the digital board
  • options (object) Type: object

    Properties:

    • primary_image_public_url (string): The public URL of the primary image
    • slot_count (string): The count of slots
    • slot_length (string): The length of slots
    • impressions_calc_method (string): See Calc Methods
    • avg_daily_impressions (string): The average daily impressions (Total all slots)
    • facing_degrees (string): The facing degrees of the digital board
    • facing_cardinal (string): See Cardinals
    • read (string): See Reads
    • pending_xr_image_url (string)
  • lcuid (string): The LCUID

  • slug (string): The unique identifier (slug)
  • address (string)
  • city (string)
  • region (string)
  • postal_code (string)
  • country (string)
  • transact_channel_class (array): An array of one or more transact channel classes See Transact Channel Classes
    • Array items: string
  • transact_channel_class_description (string)
  • media_type_class (array): An array of one or more media type classes See Media Type Classes
    • Array items: string
  • media_type_class_description (string)
  • aspect_ratio (string)
  • latitude (string)
  • longitude (string)
  • cached_tags (string)
Example Response
{
    "success": true,
    "digital_board": {
        "board_identifier": "1234-SF",
        "name": "North Washington St, SF",
        "status": 1,
        "created_at": "2026-01-07T00:14:47.000000Z",
        "updated_at": "2026-01-07T00:14:47.000000Z",
        "network": 0,
        "width": 1024,
        "height": 768,
        "hardware_provider": "daktronics",
        "software_provider": "scala",
        "description": null,
        "street_view_status": 1,
        "street_view_review_status": 0,
        "xr_status": 1,
        "venue_taxonomy_id": 301,
        "board_class": "App\\LuCore\\DigitalBoards\\DigitalBillboardBoardClass",
        "hash_id": "lch-4HsR",
        "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": []
        },
        "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-fc0abb76-6091-4c1c-ac77-3adc943511f3",
            "slug": "TestAgencyUnitTestJvffr",
            "created_at": "2026-01-07T00:14:47.000000Z",
            "updated_at": "2026-01-07T00:14:47.000000Z",
            "agency_class_description": "Operator"
        },
        "location": {
            "name": "North Washington St, SF",
            "description": "Unit Test Description - RxAcYWqYrSBItiv2rZiMOc2DsVi3fTujJyUMyv17ZyKgAKtbWgtr2OicWpONZFCdg5OLHMHrPnX95i2mnP72nWPkhNR679Rr1mFEQ5j7X8DJinGOc8eKCokQIOE9cBuAJv4exdNRngR5EftorProtl",
            "phone": "1-712-909-0670",
            "address": "3602 Timmothy Mount Apt. 314",
            "city": "West Deronchester",
            "region": "Wisconsin",
            "postal_code": "07977-9364",
            "country": "US",
            "latitude": "29.58688400000000",
            "longitude": "-124.49532400000000",
            "location_default": 1,
            "status": 1,
            "options": {
                "_init": []
            },
            "location_class": "App\\LuCore\\Locations\\GenericLocationClass",
            "lcuid": "LCUID-LL-fdd761c5-e023-4af8-a68c-f6300fba291b",
            "street_view_status": null,
            "heading": null,
            "pitch": null,
            "zoom": null,
            "hash_id": "lch-4Cu2",
            "lid": "LL2914",
            "parent_id": 22035,
            "parent_type": "App\\DigitalBoard",
            "created_at": "2026-01-07T00:14:47.000000Z",
            "updated_at": "2026-01-07T00:14:47.000000Z",
            "location_class_description": "Generic Location",
            "fov": 1
        },
        "street_view_location": {
            "name": "Unit Test - v3nWZqjZrSXAbPu",
            "description": "Unit Test Description - kan8wXywuvcJ0YJDt4Aeca020YEFICB6i1azQfMojs9Hvd87Fb4Ssyj90UcwncQyOA9aLeikIJpO74hY0lacMf7IYEIIOhBBIjpfjWQjKioWbh1MacB1Y1kGhbt3qnDcufm3WwFKurQLAd6yRqJOQB",
            "phone": "401.453.6632",
            "address": "89049 Bergnaum Extensions Suite 275",
            "city": "North Monroechester",
            "region": "Vermont",
            "postal_code": "43486-4504",
            "country": "US",
            "latitude": "28.37095800000000",
            "longitude": "-75.91110700000000",
            "location_default": 1,
            "status": 1,
            "options": {
                "_init": [],
                "digital_board_to_image_id": 41,
                "google_street_view_pano_id": null
            },
            "location_class": "App\\LuCore\\Locations\\StreetViewLocationClass",
            "lcuid": "LCUID-LL-fe82821a-2c93-4f5d-a7dd-bcf5f120d531",
            "street_view_status": 1,
            "heading": "25.26564840000000",
            "pitch": "15.26568940000000",
            "zoom": "3.26568940000000",
            "hash_id": "lch-4Cu3",
            "lid": "LL2915",
            "parent_id": null,
            "parent_type": null,
            "created_at": "2026-01-07T00:14:47.000000Z",
            "updated_at": "2026-01-07T00:14:47.000000Z",
            "location_class_description": "Street View Location",
            "fov": 23.494506937541
        },
        "open_ooh_venue_taxonomy": {
            "name": "Billboards",
            "fully_qualified_name": "Outdoor : Billboards",
            "description": "Located primarily on major roads, they attract high-density consumer exposure (mostly to vehicular traffic, but often to pedestrians).",
            "enumeration_id": 301,
            "version": "1.1",
            "child_count": 3,
            "level": 1,
            "level_name": "child",
            "parent_id": 3,
            "lcuid": "LCUID-LVT-985d993b-d81a-47fa-997b-2ed94dad71d2"
        },
        "digital_board_to_images": [
            {
                "name": "Street View Overlay",
                "style": "street_view_overlay",
                "is_main_image": 0,
                "order_number": 100,
                "lcuid": "LCUID-LBTI-c395ec94-d2e4-4778-b911-f9d6b829694a",
                "image": null,
                "options": {
                    "overlay_type": "perspective",
                    "dimension_width": 640,
                    "dimension_height": 480,
                    "overlay_perspective_coordinates": [
                        [
                            10,
                            10
                        ],
                        [
                            50,
                            7
                        ],
                        [
                            45,
                            20
                        ],
                        [
                            12,
                            19
                        ]
                    ],
                    "generic_overlay_image_public_url": "http://localhost:8080/storage/12/img_695da578024bf_f3883e0ee85ba500bd17.png"
                }
            },
            {
                "name": "Facing West",
                "style": "normal",
                "is_main_image": 1,
                "order_number": 200,
                "lcuid": "LCUID-LBTI-a9a6cd82-b23e-4c95-bd56-7a44809af262",
                "image": {
                    "options": {
                        "public_url": "http://localhost:8080/storage/13/img_695da57851615_9cc3053b50c73ceaa8e5.png",
                        "size_in_bytes": null,
                        "dimension_height": 251,
                        "dimension_width": 1151,
                        "hash_md5": "8d6b96e4c1a5cd5450f6169fedd6e9c1"
                    },
                    "mime_type": "image/png",
                    "lcuid": "LCUID-LM-88743036-fafa-4122-8e75-5e5ef342d946",
                    "hash_id": "lch-4HL2"
                },
                "options": {
                    "overlay_type": "perspective",
                    "dimension_width": null,
                    "dimension_height": null,
                    "overlay_perspective_coordinates": [
                        [
                            10,
                            10
                        ],
                        [
                            50,
                            7
                        ],
                        [
                            45,
                            20
                        ],
                        [
                            12,
                            19
                        ]
                    ],
                    "generic_overlay_image_public_url": null
                }
            }
        ],
        "board_class_description": "Digital Billboard",
        "board_size_description": "1024x768",
        "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-154dc68e-3f0a-4002-b148-a6d44c2f1399",
        "slug": "BreezyBillboardsBoard1234Sf9",
        "address": "3602 Timmothy Mount Apt. 314",
        "city": "West Deronchester",
        "region": "Wisconsin",
        "postal_code": "07977-9364",
        "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": "29.58688400",
        "longitude": "-124.49532400",
        "cached_tags": null
    }
}

Example Implementations

Bash (cURL)

curl --request GET \
    --get "https://api.lucit.app/api/v3/digital-boards/LCUID-LB-506fc585-77be-11ec-acb9-c2cdb617d190" \
    --header "Authorization: Bearer {AuthToken}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "AppIdV3: LCUID-LAP-********-****-****-****-************"

JavaScript (Fetch API)

const url = new URL(
    "https://api.lucit.app/api/v3/digital-boards/LCUID-LB-506fc585-77be-11ec-acb9-c2cdb617d190"
);

const headers = {
    "Authorization": "Bearer {AuthToken}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "AppIdV3": "LCUID-LAP-********-****-****-****-************",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

PHP (Guzzle)

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.lucit.app/api/v3/digital-boards/LCUID-LB-506fc585-77be-11ec-acb9-c2cdb617d190',
    [
        'headers' => [
            'Authorization' => 'Bearer {AuthToken}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Python (Requests)

import requests
import json

url = 'https://api.lucit.app/api/v3/digital-boards/LCUID-LB-506fc585-77be-11ec-acb9-c2cdb617d190'
headers = {
  'Authorization': 'Bearer {AuthToken}',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'AppIdV3': 'LCUID-LAP-********-****-****-****-************'
}

response = requests.request('GET', url, headers=headers)
response.json()

← Back to digital-boards index | Back to main index