GET /api/v3/campaigns/extensions/apx/{apxContractId}

Summary

GET campaigns/extensions/apx/{getApxContractId}

Description

Return a the mapped campaign for a given apparatix contract ID

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

Properties:

• apx_contract_id (string): The apx contract id

• options (object) Type: object

  Properties:

  • _init (array)

• agency_id (integer)

• link_status (integer)
• pulling_status (integer)
• last_pull_at (string)
• created_at (string)
• updated_at (string)

• campaign (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
  • watchfire_ignite_media_uuids (string)

  • watchfire_ignite_advertiser_id (string)

  • schedule (string)

  • id (integer)
  • build_status (integer)
  • last_build_at (string)

Example Response

{
    "success": true,
    "apx_contract_map": {
        "apx_contract_id": "00PCY-JnK1mgVyar",
        "options": {
            "_init": []
        },
        "agency_id": 5975,
        "link_status": 3,
        "pulling_status": 1,
        "last_pull_at": null,
        "created_at": "2026-01-07T00:10:47.000000Z",
        "updated_at": "2026-01-07T00:10:47.000000Z",
        "campaign": {
            "name": "Breezy Billboards North Washington",
            "lcuid": "LCUID-LE-d901e570-b8e1-4e9a-ae9a-31a7e5665cff",
            "active": true,
            "created_at": "2026-01-07T00:10:47.000000Z",
            "campaign_state": 6,
            "campaign_state_changed_at": null,
            "hash_id": "lch-4CPf",
            "campaign_class": "App\\LuCore\\Campaigns\\OperatorContractCampaignClass",
            "campaign_class_description": "Media Owner Contract",
            "options": {
                "unique_board_sizes": [
                    "1024x768"
                ],
                "unique_board_formats": [
                    "oddblock"
                ],
                "watchfire_ignite_media_uuids": null,
                "watchfire_ignite_advertiser_id": null
            },
            "schedule": null,
            "id": 1031,
            "build_status": 7,
            "last_build_at": null
        }
    }
}

Example Implementations

Bash (cURL)

curl --request GET \
  --url "https://api.lucit.app/api/v3/campaigns/extensions/apx/{apxContractId}" \
  --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/campaigns/extensions/apx/{apxContractId}";

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/campaigns/extensions/apx/{apxContractId}', [
  '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/campaigns/extensions/apx/{apxContractId}"

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

response = requests.get(url, headers=headers)
print(response.json())

---

← Back to campaigns index | Back to main index