GET /api/v3/creatives/{lcuid}

Summary

GET /creatives/{id}

Description

Returns a single creative

🔒 Required Permissions

At least one of the following permissions is required to access this endpoint:

• account.viewContent

Tags: creatives

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

Content Type: application/json

Schema

Type: object

Properties:

• success (boolean): true
• creative (object) Type: object

Properties:

• order_number (integer): The order number of the creative, useful for sorting the most recent creative first
• status (integer): the creative status See Creative Statuses
• unique_hash (string): A unique hash for the creative. This is a hash of all of the parts that make up this creative including data points, template parts, etc. Useful for determining if the underlying data that generated this creative, has changed
• lcuid (string): The lcuid of the creative
• hash_id (string)

• inventory_item (object) Type: object

  Properties:

  • unique_id (string)
  • title (string)
  • status (integer)
  • item_class (string)
  • creative_state (integer)
  • lcuid (string)

• creative_approvals (array): An array of creative approval objects by media owner See Creative Approval Statuses

• options (object) Type: object

  Properties:

  • size_in_bytes (string)
  • dimension_height (integer): The height of the creative in pixels
  • dimension_width (integer): The width of the creative in pixels
  • hash_md5 (string)
  • public_url (string): The public url of the creative image file

• xr_status (integer)

• drive_template_id (string)

Example Response

{
    "success": true,
    "creative": {
        "order_number": 100,
        "status": 1,
        "unique_hash": "adb1b5617b20736a20cb45dde163dc5a",
        "lcuid": "LCUID-LP-9e4a831f-ae98-408c-a20e-14cffc5e1d1e",
        "hash_id": "lch-4D5m",
        "inventory_item": {
            "unique_id": "whXiHO7mUT",
            "title": "Unit Test - pwkbxnH5EhX93VK",
            "status": 1,
            "item_class": "App\\LuCore\\InventoryItems\\GenericInventoryItemClass",
            "creative_state": 0,
            "lcuid": "LCUID-LI-68501fb6-7bd4-4985-b5ee-2fab37f0c299"
        },
        "creative_approvals": [],
        "options": {
            "size_in_bytes": null,
            "dimension_height": 251,
            "dimension_width": 1151,
            "hash_md5": "8d6b96e4c1a5cd5450f6169fedd6e9c1",
            "public_url": "http://localhost:8080/storage/13/3441/img_695da5525d378_2f92cead7dd442a7dd4f.png"
        },
        "xr_status": 0,
        "drive_template_id": null
    }
}

Example Implementations

Bash (cURL)

curl --request GET \
    --get "https://api.lucit.app/api/v3/creatives/LCUID-LP-989f75f4-8cdd-4e09-a93b-0478660da53a" \
    --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/creatives/LCUID-LP-989f75f4-8cdd-4e09-a93b-0478660da53a"
);

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/creatives/LCUID-LP-989f75f4-8cdd-4e09-a93b-0478660da53a',
    [
        '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/creatives/LCUID-LP-989f75f4-8cdd-4e09-a93b-0478660da53a'
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 creatives index | Back to main index