GET /api/v3/campaigns

Summary

GET campaigns

Description

Return a list of campaigns

See Campaign for details on the campaign object

Tags: campaigns

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)
• campaigns (array)

• Array items: object Type: object

  Properties:

  • name (string)
  • lcuid (string)
  • active (boolean)
  • created_at (string)
  • campaign_state (integer)
  • campaign_state_changed_at (string)
  • hash_id (string)
  • campaign_class (string)
  • campaign_class_description (string)
  • options (object) Type: object

  Properties:

  • unique_board_sizes (array)
    • Array items: string

  • unique_board_formats (array)

    • Array items: string

  • schedule (string)

  • build_status (integer)
  • last_build_at (string)

Example Response

{
    "success": true,
    "campaigns": [
        {
            "name": "Breezy Billboards South Washington",
            "lcuid": "LCUID-LE-b479c0ab-a80d-49bb-b003-39193423dc73",
            "active": true,
            "created_at": "2026-01-07T00:14:06.000000Z",
            "campaign_state": 6,
            "campaign_state_changed_at": null,
            "hash_id": "lch-4CPu",
            "campaign_class": "App\\LuCore\\Campaigns\\OperatorContractCampaignClass",
            "campaign_class_description": "Media Owner Contract",
            "options": {
                "unique_board_sizes": [
                    "1024x768"
                ],
                "unique_board_formats": [
                    "oddblock"
                ]
            },
            "schedule": null,
            "build_status": 7,
            "last_build_at": null
        },
        {
            "name": "Breezy Billboards North Washington",
            "lcuid": "LCUID-LE-9665b64c-10dc-47c5-a016-21e0ac629c12",
            "active": true,
            "created_at": "2026-01-07T00:14:07.000000Z",
            "campaign_state": 6,
            "campaign_state_changed_at": null,
            "hash_id": "lch-4CPv",
            "campaign_class": "App\\LuCore\\Campaigns\\OperatorContractCampaignClass",
            "campaign_class_description": "Media Owner Contract",
            "options": {
                "unique_board_sizes": [
                    "1024x768"
                ],
                "unique_board_formats": [
                    "oddblock"
                ]
            },
            "schedule": null,
            "build_status": 7,
            "last_build_at": null
        }
    ]
}

Example Implementations

Bash (cURL)

curl --request GET \
    --get "https://api.lucit.app/api/v3/campaigns" \
    --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/campaigns"
);

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/campaigns',
    [
        '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/campaigns'
headers = {
  'Authorization': 'Bearer {AuthToken}',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'AppIdV3': 'LCUID-LAP-********-****-****-****-************'
}

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

Example Responses

200 Response

{
    "success": true,
    "campaigns": [
        {
            "name": "Breezy Billboards South Washington",
            "lcuid": "LCUID-LE-b479c0ab-a80d-49bb-b003-39193423dc73",
            "active": true,
            "created_at": "2026-01-07T00:14:06.000000Z",
            "campaign_state": 6,
            "campaign_state_changed_at": null,
            "hash_id": "lch-4CPu",
            "campaign_class": "App\\LuCore\\Campaigns\\OperatorContractCampaignClass",
            "campaign_class_description": "Media Owner Contract",
            "options": {
                "unique_board_sizes": [
                    "1024x768"
                ],
                "unique_board_formats": [
                    "oddblock"
                ]
            },
            "schedule": null,
            "build_status": 7,
            "last_build_at": null
        },
        {
            "name": "Breezy Billboards North Washington",
            "lcuid": "LCUID-LE-9665b64c-10dc-47c5-a016-21e0ac629c12",
            "active": true,
            "created_at": "2026-01-07T00:14:07.000000Z",
            "campaign_state": 6,
            "campaign_state_changed_at": null,
            "hash_id": "lch-4CPv",
            "campaign_class": "App\\LuCore\\Campaigns\\OperatorContractCampaignClass",
            "campaign_class_description": "Media Owner Contract",
            "options": {
                "unique_board_sizes": [
                    "1024x768"
                ],
                "unique_board_formats": [
                    "oddblock"
                ]
            },
            "schedule": null,
            "build_status": 7,
            "last_build_at": null
        }
    ]
}

---

← Back to campaigns index | Back to main index