Lucit API Documentation (V3)¶

Note: This documentation has been automatically generated from the OpenAPI specification. It is optimized for consumption by Large Language Models (LLMs) and AI assistants.

Source Files¶

This documentation is generated from the following source files:

OpenAPI Specification - Complete API specification in OpenAPI 3.0 format
Postman Collection - Importable collection for testing with Postman

Description¶

An API for connecting to the Lucit backend for digital billboard creatives, management, and analytics

API Version: 1.0.0

Base URLs¶

https://api.lucit.app

This documentation describes each of the endpoints available in the Lucit V3 api

Version : BETA¶

This documentation is currently in BETA and may not be completely up to date or accurate. Please contact support@lucit.cc for integration questions or issues with this documentation

Audience¶

This documentation is for developers who wish to build applications that interface with Lucit data.

Lucit is the only open development platform for dynamic digital out of home.

Control your digital signage and digital billboard campaigns, content, creatives and fetch analytics, POP play reports, and impression data all from a single API. Cross-vendor, cross-platform.

Guides and Developer Documentation¶

For detailed guides how-to's and more, visit Lucit Developer Information, Help & Guides

Testing with `lucit-cli`¶

Install the lucit-cli command line application on Linux, Windows and MacOS for quick and easy commands to test various Lucit API endpoints

Get the lucit-cli from https://github.com/lucit-cc/lucit-cli

Building an App¶

Building an app starts within the Lucit Platform under your personal profile with Developer Mode turned on

Once enabled, you will see a list of apps that you have created and you will be able to add a new app.

An app in Lucit can then have one or more API tokens / secrets generated for it.

You will then use your App ID, your Token and your secret to accss this API

See Authenticating Requests for information on authentication and Lucit Developer Information, Help & Guides for information on building your first application

Example use cases¶

Reporting	You wish to automatically pull reporting data for your campaigns
Screen Player / CMS Systems	Connect to Lucit campaigns to allow them to play on screens that run your software. (Note, for legacy implementations, V1 API Docs )
CRM Systems	Automatically generate matching accounts in Lucit
Creatives	Publish creatives to Lucit campaigns
Creative Inventory Connectivity	Automatically enable / disable specific creatives based on your external critera.
Data Sources	Add your data to Lucit to work with the Lucit Data Sources for creating dynamic creatives

Key Definitions¶

The following are a few key items in Lucit

AppIdV3	Every request to Lucit API requires a Header variable `AppIdV3` which must contain the Lucit Application lcuid that you are making requests on behalf of. This application id is visible in the General tab of your application settings and takes the form `LCUID-LAP-d1b0465d-aaac-4f18-9080-d325309a441b`. All Application ids begin with `LCUID-LAP`
lcuid	An lcuid is a unique UUID for each object in Lucit. A lcuid will take the form `LCUID-LA-539e6747-b9b6-48a8-8ba1-f7a8e291881e` where we have 3 basic parts, `LCUID` constant prefix, `LA` a code the indicates the type of object (LA is an Account) and `539e6747-b9b6-48a8-8ba1-f7a8e291881e` the the 5 part UUID
slug	An Object slug is a URL friendly name for an object. For instance, it could be `BlueRiverRealEstate12`

Lucit Objects¶

There are various lucit objects, some of which have historical names that may or may not make sense. The following describes these objects and their relationships.

In addition some objects can be created via this api and some cannot. Additionaly some objects can be deleted by this api and some cannot

Object	Description	Create	Delete
Account	A Lucit account is a container for Campaigns and Creatives. Accounts will normally be assigned to an Operator or Ad Agency	Yes	Yes
Agency	An Agency can either represent a Media Owner (Billboard Operator) or an Ad Agency. Agencies are containers for one or more accounts and, if an Operator, will contain a set of digital billboards (screens)	No	No
Application	A Lucit Applicaton is a container for all third-party functionality in Lucit. Applications are a primary object in Lucit and applications contain one or more Capabilities (via Capability Classes). Applications can provide permissions and tokens for accessing the Lucit API.	No	No
Campaign	A Campaign is a container for Creatives (Via their Inventory Item Objects). Campaigns are assigned to an Account and can be assigned to one or more Digital Boards	Yes	Yes
Creative	A creative represents a single creative image that is designed to be played on a digital board of a specific size (width/height). Creatives belong to Inventory Item objects	No	No
Data Source Provider	A data source provider, is the container object from which a data source is built. The data source provider describes the functionality of the data source, the method for fetching data, and exposes any configuration options to the data source. A data source provider belongs to an Application that has the DataSourceApplicationCapabilityClass capability. Multiple Data Sources can be created from a single data source provider.	No	No
Data Source	A data source, is an object that describes how to get inventory items and other data into Lucit. Data Sources are attached to Apps via Data Source Providers and are typically added to accounts via the Lucit Application UI Data sources could be eCommerce product data, vehicle inventory, real estate property, social feeds, RSS feeds, weather data, etc. Most inventory items belong to the data source that created them.	No	No
Digital Board	A digital board represents a single Screen that can display content. Digital Boards are assigned to Agencies	Yes	Yes
Digital Board to Image	1 or more images attached to a digital board that describes how this board looks in the real world. Typically these are approach or drone shots, but can also be overlays on street view images	No	No
Drive Template	A template that was created in the Lucit Template Designer that is used to generate creatives. Typically these are attached to Inventory Item objects	Yes	Yes
Drive Template Element	An element that is available to be used when designing a Drive Template.	No	No
Font	A Font is used by a template when rendering text	No	No
Inventory Item	An Inventory Item directly represents a specific ad and acts as a container for 1 or more creatives. Inventory Items can be posted manually (creatives and via templates) or can map to third party items such as Products, Vehicles, Properties, etc. Inventory Item's belong to Account Objects and may be created by users manually (when posting ads) or via data sources automatically	Yes	Yes
Location	A location represents a geographic location and has various properties including lat/long and other information regarding this location. Typically a Digital Board has a location object attached to it that will tell you where this board is	No	No
Street View Location	A special kind of Location that represents the best point to view a digital board from. Heading, Pitch and Zoom are added in order to know geospacially how to view a digital billboard face.	No	No

Mapping Vendor ID's to Lucit Objects¶

The following objects have the ability to store unique vendor (third party) id's that you can use to reference them, and relate them back to your own internal data

Digital Board	`board_identifier`	The vendor specific ID for a digital_board object is the `board_identifier` You should map this id to the internal ID you use for the digital board in your system. Most often, these ID's are the ID's that the media owners would use to refer to this digital board
Inventory Item	`unique_id`	This id should be mapped to your own internal product or inventory id's. For example, in an eCommerce platform this could be a product id or a sku. For automotive inventory it could be a vin or a dealer stock number. For real estate, MLS Numbers make the most sense here

Authenticating Requests¶

This API is authenticated by sending an Authorization header with the value "Bearer {AuthToken}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Every authenticated request requires a Header variable containing your AppIdV3 ID This ID is the application ID for the application you are connecting on behalf of.

You authenticate with the Lucit API by requesting a token from the /auth endpoint using the login token and secret for one of the tokens assigned to your app. You view view / create these tokens in Lucit by enabling the developer options in your personal settings and clicking on applications.

You can view your current applications by Clicking Here

You can retrieve the AppIdV3 for your application by viewing the Application ID: for your app in the General tab of your application settings.

Quick Start to Authentication¶

Create a new app in Lucit Apps - Note your Application ID which will be used in your AppIdV3 header
Generate a token and secret on the TOKENS tab.
Form a request to with your AppIdV3 header, your token and your secret


 Store the resulting token.  This is your Bearer token and must be sent to every request to other endpoints
 Test your token by making a request to the /status endpoint



Table of Contents¶
This API documentation is organized by resource category. Each endpoint has its own detailed documentation file with complete information about parameters, request/response schemas, examples, and code implementations in multiple languages.
Documentation Statistics¶

Total Endpoints: 135
Resource Categories: 19
Categories: accounts, agencies, analytics, applications, auth, campaigns, creatives, data-source-providers, digital-boards, drive-templates, fonts, images, inventory-items, lightning, objects, public, secrets, status, support

Quick Navigation¶
Browse by category to find the endpoints you need:

Accounts
Agencies
Analytics
Applications
Auth
Campaigns
Creatives
Data Source Providers
Digital Boards
Drive Templates
Fonts
Images
Inventory Items
Lightning
Objects
Public
Secrets
Status
Support


API Endpoints by Category¶
Accounts¶
📂 View Accounts Index

🔵 GET /api/v3/accounts - GET accounts
🟢 POST /api/v3/accounts - POST accounts
🔵 GET /api/v3/accounts/constants/account-classes - GET /accounts/constants/account-classes
🔵 GET /api/v3/accounts/constants/field-map - GET /accounts/constants/field-map
🔵 GET /api/v3/accounts/constants/roles - GET /accounts/constants/roles
🟡 PUT /api/v3/accounts/{lcuid} - PUT accounts/{id}
🔵 GET /api/v3/accounts/{lcuid} - GET accounts/{id}
🔵 GET /api/v3/accounts/{lcuid}/analytics/by-campaign - GET accounts/{id}/analytics/by-campaign
🔵 GET /api/v3/accounts/{lcuid}/analytics/by-item - GET accounts/{id}/analytics/by-item
🔵 GET /api/v3/accounts/{lcuid}/analytics/by-period - GET accounts/{id}/analytics/by-period
🔵 GET /api/v3/accounts/{lcuid}/analytics/by-screen - GET accounts/{id}/analytics/by-screen
🔵 GET /api/v3/accounts/{lcuid}/applications - GET accounts/{id}/applications
🔵 GET /api/v3/accounts/{lcuid}/campaigns - GET accounts/{id}/campaigns
🔵 GET /api/v3/accounts/{lcuid}/data-sources - GET accounts/{id}/data-sources
🔵 GET /api/v3/accounts/{lcuid}/default-creative - GET accounts/{id}/default-creative
🔵 GET /api/v3/accounts/{lcuid}/drive-templates - GET accounts/{id}/drive-templates
🔵 GET /api/v3/accounts/{lcuid}/inventory-items - GET accounts/{id}/inventory-items

Agencies¶
📂 View Agencies Index

🔵 GET /api/v3/agencies - GET agencies
🔵 GET /api/v3/agencies/constants/agency-classes - GET /agencies/constants/agency-classes
🔵 GET /api/v3/agencies/constants/roles - GET /agencies/constants/roles
🔵 GET /api/v3/agencies/{lcuid} - GET agencies/{id}
🔵 GET /api/v3/agencies/{lcuid}/accounts - GET agencies/{id}/accounts
🔵 GET /api/v3/agencies/{lcuid}/campaigns - GET agencies/{id}/campaigns
🔵 GET /api/v3/agencies/{lcuid}/digital-boards - GET agencies/{id}/digital-boards
🔵 GET /api/v3/agencies/{lcuid}/lightning-devices - GET agencies/{id}/lightning-devices

Analytics¶
📂 View Analytics Index

🔵 GET /api/v3/analytics/constants/periods - GET /analytics/constants/periods
🔵 GET /api/v3/analytics/constants/timeframes - GET /analytics/constants/timeframes
🟢 POST /api/v3/analytics/lightning-devices/{lcuid}/heartbeat - POST /analytics/lightning-devices/{lcuid}/heartbeat

Applications¶
📂 View Applications Index

🔵 GET /api/v3/applications - GET applications
🔵 GET /api/v3/applications/constants/application-capabilities - GET /applications/constants/application-capabilities
🔵 GET /api/v3/applications/constants/application-classes - GET /applications/constants/application-classes
🔵 GET /api/v3/applications/constants/permissions - GET /applications/constants/permissions
🔵 GET /api/v3/applications/{lcuid} - GET applications/{id}
🔵 GET /api/v3/applications/{lcuid}/data-source-providers - GET /v3/applications/{lcuid}/data-source-providers
Return the data source providers for an application
🔵 GET /api/v3/applications/{lcuid}/edges/{object_lcuid}/capability-param-values - GET /v3/applications/{lcuid}/edges/{object_lcuid}/capability-param-values
Return the capability param values for an object
🔵 GET /api/v3/applications/{lcuid}/key-value-store - GET applications/{id}/key-value-store
🟢 POST /api/v3/applications/{lcuid}/key-value-store - POST applications/{id}/key-value-store
🔵 GET /api/v3/applications/{lcuid}/key-value-store/{key} - GET applications/{id}/key-value-store/{key}
🔴 DELETE /api/v3/applications/{lcuid}/key-value-store/{key} - DELETE applications/{id}/key-value-store/key

Auth¶
📂 View Auth Index

🟢 POST /api/v3/auth - POST auth

Campaigns¶
📂 View Campaigns Index

🔵 GET /api/v3/campaigns - GET campaigns
🟢 POST /api/v3/campaigns - POST campaigns
🔵 GET /api/v3/campaigns/constants/build-statuses - GET /campaigns/constants/build-statuses
🔵 GET /api/v3/campaigns/constants/campaign-classes - GET /campaigns/constants/campaign-classes
🔵 GET /api/v3/campaigns/constants/campaign-states - GET /campaigns/constants/campaign-states
🔵 GET /api/v3/campaigns/extensions/apx/{apxContractId} - GET campaigns/extensions/apx/{getApxContractId}
🔵 GET /api/v3/campaigns/extensions/px/{pxDealId} - GET campaigns/extensions/px/{pxDealId}
🔵 GET /api/v3/campaigns/extensions/vistar/{vistarInsertionOrderId} - GET campaigns/extensions/vistar/{vistarInsertionOrderId}
🔵 GET /api/v3/campaigns/extensions/watchfire/campaigns - GET /v3/campaigns/extensions/watchfire/campaigns
🔵 GET /api/v3/campaigns/{lcuid} - GET campaigns/{id}
🟡 PUT /api/v3/campaigns/{lcuid} - PUT campaigns/{id}
🔵 GET /api/v3/campaigns/{lcuid}/digital-boards - GET campaigns/{lcuid}/digital-boards
🟡 PUT /api/v3/campaigns/{lcuid}/digital-boards - PUT campaigns/{lcuid}/digital-boards
🔴 DELETE /api/v3/campaigns/{lcuid}/digital-boards/{id} - DELETE campaigns/{lcuid}/digital-boards/{id}
🔵 GET /api/v3/campaigns/{lcuid}/inventory-items - GET campaigns/{lcuid}/inventory-items
🟡 PUT /api/v3/campaigns/{lcuid}/inventory-items - PUT campaigns/{lcuid}/inventory-items
🔴 DELETE /api/v3/campaigns/{lcuid}/inventory-items/{id} - DELETE campaigns/{lcuid}/inventory-items/{id}
🟡 PUT /api/v3/campaigns/{lcuid}/inventory-items/{id}/board-filter - PUT campaigns/{lcuid}/inventory-items/{id}/board-filter
🟡 PUT /api/v3/campaigns/{lcuid}/inventory-items/{id}/digital-boards - PUT campaigns/{lcuid}/inventory-items/{id}/digital-boards
🔵 GET /api/v3/campaigns/{lcuid}/pull/{boardIdentifier} - GET campaigns/{id}/pull/{boardIdentifier}

Creatives¶
📂 View Creatives Index

🔵 GET /api/v3/creatives/constants/approval-statuses - GET /creatives/constants/approval-statuses
🔵 GET /api/v3/creatives/constants/statuses - GET /creatives/constants/statuses
🟢 POST /api/v3/creatives/multi-assets - GET /creatives/multi-assets
Returns multiple creatives with base64 encoded images, and optionally HTML
🟢 POST /api/v3/creatives/multi-base64 - GET /creatives/multi-assets
Returns multiple creatives with base64 encoded images, and optionally HTML
🔵 GET /api/v3/creatives/{lcuid} - GET /creatives/{id}
🔵 GET /api/v3/creatives/{lcuid}/base64 - GET /creatives/{id}/base64
Returns a single creative as a base64 encoded image

Data Source Providers¶
📂 View Data Source Providers Index

🔵 GET /api/v3/data-source-providers/{lcuid} - GET data-source-providers/{id}
🔵 GET /api/v3/data-source-providers/{lcuid}/feed-param-fields - GET data-source-providers/{id}/feed-param-fields
🔵 GET /api/v3/data-source-providers/{lcuid}/field-map - GET data-source-providers/{id}/field-map

Digital Boards¶
📂 View Digital Boards Index

🔵 GET /api/v3/digital-boards - GET digital-boards
🟢 POST /api/v3/digital-boards - POST digital-boards
🔵 GET /api/v3/digital-boards/constants/digital-board-formats - GET /digital-boards/constants/digital-board-formats
🔵 GET /api/v3/digital-boards/constants/digital-board-statuses - GET /digital-boards/constants/digital-board-statuses
🔵 GET /api/v3/digital-boards/constants/facing-cardinals - GET /digital-boards/constants/facing-cardinals
🔵 GET /api/v3/digital-boards/constants/field-map - GET /digital-boards/constants/field-map
🔵 GET /api/v3/digital-boards/constants/hardware-providers - GET /digital-boards/constants/hardware-providers
🔵 GET /api/v3/digital-boards/constants/impressions-calc-methods - GET /digital-boards/constants/impressions-calc-methods
🔵 GET /api/v3/digital-boards/constants/media-type-classes - GET /digital-boards/constants/media-type-classes
🔵 GET /api/v3/digital-boards/constants/reads - GET /digital-boards/constants/reads
🔵 GET /api/v3/digital-boards/constants/software-providers - GET /digital-boards/constants/software-providers
🔵 GET /api/v3/digital-boards/constants/street-view-review-statuses - GET /digital-boards/constants/street-view-review-statuses
🔵 GET /api/v3/digital-boards/constants/street-view-statuses - GET /digital-boards/constants/street-view-statuses
🔵 GET /api/v3/digital-boards/constants/transact-channel-classes - GET /digital-boards/constants/transact-channel-classes
🔵 GET /api/v3/digital-boards/constants/venue-taxonomy-ids - GET /digital-boards/constants/venue-taxonomy-ids
🔵 GET /api/v3/digital-boards/constants/xr-statuses - GET /digital-boards/constants/xr-statuses
🔵 GET /api/v3/digital-boards/{lcuid} - GET digital-boards/{id}
🟡 PUT /api/v3/digital-boards/{lcuid} - PUT digital-boards/{id}
🟢 POST /api/v3/digital-boards/{lcuid}/analytics/process-play-report - POST digital-board/{id}/analytics/process-play-report
🟢 POST /api/v3/digital-boards/{lcuid}/analytics/record-play - POST digital-board/{id}/analytics/record-play
🟢 POST /api/v3/digital-boards/{lcuid}/analytics/record-plays - POST digital-board/{id}/analytics/record-plays
🔵 GET /api/v3/digital-boards/{lcuid}/playlist - GET digital-boards/{lcuid}/playlist

Drive Templates¶
📂 View Drive Templates Index

🟢 POST /api/v3/drive-templates - POST /drive-templates
🔵 GET /api/v3/drive-templates/constants/drive-template-element-classes - GET /drive-templates/constants/drive-template-element-classes
🔵 GET /api/v3/drive-templates/constants/drive-template-element-types - GET /drive-templates/constants/drive-template-element-types
🔵 GET /api/v3/drive-templates/constants/elements/public - GET /drive-templates/elements/public
🔵 GET /api/v3/drive-templates/fonts/public - GET /drive-templates/fonts/public
🔵 GET /api/v3/drive-templates/{lcuid} - GET /drive-templates/{lcuid}
🟡 PUT /api/v3/drive-templates/{lcuid} - PUT /drive-templates/{lcuid}
🔵 GET /api/v3/drive-templates/{lcuid}/field-map - GET /drive-templates/{lcuid}/field-map

Fonts¶
📂 View Fonts Index

🟢 POST /api/v3/fonts - POST /fonts
🔵 GET /api/v3/fonts/my - GET /fonts/my
🔵 GET /api/v3/fonts/{lcuid} - GET /fonts/{id}

Images¶
📂 View Images Index

🟢 POST /api/v3/images - POST /images
🔵 GET /api/v3/images/my - GET /images/my
🔵 GET /api/v3/images/{lcuid} - GET /images/{id}

Inventory Items¶
📂 View Inventory Items Index

🟢 POST /api/v3/inventory-items - POST /inventory-items
🔵 GET /api/v3/inventory-items/constants/creative-states - GET /inventory-items/constants/creative-states
🔵 GET /api/v3/inventory-items/constants/field-map - GET /inventory-items/constants/field-map
🔵 GET /api/v3/inventory-items/constants/inventory-item-classes - GET /inventory-items/constants/inventory-item-classes
🔵 GET /api/v3/inventory-items/constants/inventory-item-statuses - GET /inventory-items/constants/inventory-item-statuses
🔵 GET /api/v3/inventory-items/constants/price-modifiers - GET /inventory-items/constants/price-modifiers
🟡 PUT /api/v3/inventory-items/{lcuid} - PUT /inventory-items/{lcuid}
🔵 GET /api/v3/inventory-items/{lcuid} - GET /inventory-items/{id}

Lightning¶
📂 View Lightning Index

🟢 POST /api/v3/lightning/device-request/{lcuid}/check-for-device - GET /lightning/device-request/{lcuid}/check-for-device
🟢 POST /api/v3/lightning/device-requests/request - POST /lightning/device-requests/request
🔵 GET /api/v3/lightning/devices/{lcuid} - GET /lightning/devices/{lcuid}
🟢 POST /api/v3/lightning/devices/{lcuid}/instructions/{instruction_lcuid}/acknowledge - POST /lightning/devices/{lcuid}/instructions/{instruction_lcuid}/acknowledge
🟢 POST /api/v3/lightning/devices/{lcuid}/instructions/{instruction_lcuid}/failed - POST /lightning/devices/{lcuid}/instructions/{instruction_lcuid}/failed
🟢 POST /api/v3/lightning/devices/{lcuid}/instructions/{instruction_lcuid}/success - POST /lightning/devices/{lcuid}/instructions/{instruction_lcuid}/success
🟢 POST /api/v3/lightning/devices/{lcuid}/log - POST /lightning/devices/{lcuid}/log

Objects¶
📂 View Objects Index

🔵 GET /api/v3/objects/{id} - GET /objects/{lcuid}
🔴 DELETE /api/v3/objects/{lcuid} - DELETE /objects/{id}
🔵 GET /api/v3/objects/{lcuid}/can-be-deleted - GET /objects/{id}/can-be-deleted
🔵 GET /api/v3/objects/{lcuid}/scoped-tags - GET /objects/{lcuid}/scoped-tags
🟢 POST /api/v3/objects/{lcuid}/scoped-tags - POST /objects/{lcuid}/scoped-tags
🟡 PUT /api/v3/objects/{lcuid}/scoped-tags/{tag_lcuid} - PUT /objects/{lcuid}/scoped-tags/{tag_lcuid}
🔵 GET /api/v3/objects/{lcuid}/tags - GET /objects/{lcuid}/tags
🟢 POST /api/v3/objects/{lcuid}/tags/add/{tag_lcuid} - POST /objects/{lcuid}/tags/add/{tag_lcuid}
🟢 POST /api/v3/objects/{lcuid}/tags/set - POST /objects/{lcuid}/tags/set
🔴 DELETE /api/v3/objects/{lcuid}/tags/{tag_lcuid} - DELETE /objects/{lcuid}/tags/{tag_lcuid}

Public¶
📂 View Public Index

🔵 GET /api/v3/public/status - GET public/status
🟢 POST /api/v3/public/support - POST public/support

Secrets¶
📂 View Secrets Index

🟢 POST /api/v3/secrets/encrypt - POST /secrets/encrypt

Status¶
📂 View Status Index

🔵 GET /api/v3/status - GET status

Support¶
📂 View Support Index

🟢 POST /api/v3/support - POST support


Navigation Tips¶

Browse by category - Use the quick navigation links above to jump to a specific resource category
Category indexes - Each category has its own index page with a list of all endpoints in that category
Endpoint files - Each endpoint has a complete documentation file with:
Request/response schemas
Parameter documentation
Example requests and responses
Code examples in Bash, JavaScript, PHP, and Python

Features¶
Every Endpoint Includes:¶
✅ Complete Documentation
- HTTP method, path, and description
- All parameters (headers, path, query, body)
- Request and response schemas
- Security/authentication requirements
✅ Working Examples
- Example JSON requests (for POST/PUT/PATCH)
- Example JSON responses (for all status codes)
✅ Code Implementations
- Bash (cURL) - Ready to run in terminal
- JavaScript (Fetch API) - Modern browser/Node.js
- PHP (Guzzle) - Using popular HTTP client
- Python (Requests) - Using requests library
LLM-Optimized Format¶
This documentation is specifically designed for AI/LLM consumption:
- 📝 Pure markdown format
- 🎯 Self-contained endpoint files
- 📊 Structured tables and code blocks
- 🔗 Clear linking between related endpoints
- 💡 Complete context in each file

Getting Started¶
Authentication¶
All API requests require authentication using:
- Authorization Header: Bearer {AuthToken}
- App ID Header: AppIdV3: LCUID-LAP-********-****-****-****-************
Common Headers¶
Authorization: Bearer {YourAuthToken}
Content-Type: application/json
Accept: application/json
AppIdV3: {YourApplicationId}

Example Request¶
curl --request GET \
  --url "https://api.lucit.app/api/v3/accounts" \
  --header "Authorization: Bearer {AuthToken}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "AppIdV3: LCUID-LAP-********-****-****-****-************"


Support¶
For API support, questions, or issues:
- Review the endpoint-specific documentation
- Check example implementations in your preferred language
- Refer to the response examples for expected data formats

Documentation generated from OpenAPI specification on 2026-02-06 16:41:30 UTC

Lucit API Documentation (V3)¶

Source Files¶

Description¶

Base URLs¶

Version : BETA¶

Audience¶

Guides and Developer Documentation¶

Testing with lucit-cli¶

Building an App¶

Example use cases¶

Key Definitions¶

Lucit Objects¶

Mapping Vendor ID's to Lucit Objects¶

Authenticating Requests¶

Quick Start to Authentication¶

Table of Contents¶

Documentation Statistics¶

Quick Navigation¶

API Endpoints by Category¶

Accounts¶

Agencies¶

Analytics¶

Applications¶

Auth¶

Campaigns¶

Creatives¶

Data Source Providers¶

Digital Boards¶

Drive Templates¶

Fonts¶

Images¶

Inventory Items¶

Lightning¶

Objects¶

Public¶

Secrets¶

Status¶

Support¶

Navigation Tips¶

Features¶

Every Endpoint Includes:¶

LLM-Optimized Format¶

Getting Started¶

Authentication¶

Common Headers¶

Example Request¶

Support¶

Testing with `lucit-cli`¶