List campaign items

GET

/campaign-items

Retrieves a paginated list of campaign items with advanced search and sorting.

Search Capabilities:

Searches across item name, artwork name, POS number, element name

Supports regex pattern matching with case-insensitive search

Complex aggregation pipeline for performance optimization

Sorting Options:

Custom sorting by status with special logic for draft states

Artwork name and campaign item name with case-insensitive comparison

Standard fields: updatedAt, createdAt, qty, approvalWorkflow

Post-aggregation sorting for workflow template names

Enhanced Fields:

Computed isLocked field (item locked OR in production OR campaign item locked)

Status field with enhanced values for better sorting

Flattened artwork and item information for search performance

Population:

Full item details including artworks and element information

Segmentation rules and campaign information

Artwork job details and file information

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Query Params

Responses

🟢200OK

application/json

Campaign items retrieved successfully

Body

🟠400Bad Request

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://prod.your-api-server.com/campaign-items?limit=25&skip=0&search=flyer&sort=updatedAt:-1&campaignId=550e8400-e29b-41d4-a716-446655440000' \
--header 'Authorization: <api-key>'

Response Example

200 - Paginated list of campaign items

{
    "campaignItemIds": [
        "880e8400-e29b-41d4-a716-446655440003",
        "990e8400-e29b-41d4-a716-446655440004"
    ],
    "campaignItemEntities": {
        "880e8400-e29b-41d4-a716-446655440003": {
            "_id": "880e8400-e29b-41d4-a716-446655440003",
            "clientId": "client123",
            "campaignId": {
                "_id": "550e8400-e29b-41d4-a716-446655440000",
                "name": "Summer Sale 2025"
            },
            "itemId": {
                "_id": "660e8400-e29b-41d4-a716-446655440001",
                "name": "Promotional Flyer",
                "posNumber": "FLY001",
                "artworks": [
                    {
                        "_id": "770e8400-e29b-41d4-a716-446655440004",
                        "name": "Flyer Artwork",
                        "fileId": {
                            "url": "/files/flyer-artwork.jpg",
                            "thumbnailUrl": "/files/thumbs/flyer-artwork.jpg"
                        }
                    }
                ],
                "elementId": {
                    "_id": "990e8400-e29b-41d4-a716-446655440006",
                    "name": "A4 Flyer"
                },
                "workflowTemplateName": "Standard Approval"
            },
            "status": 102,
            "qty": 500,
            "isLocked": false,
            "hasArtwork": true,
            "hasAllocations": true,
            "updatedAt": "2025-09-09T14:30:00Z"
        },
        "990e8400-e29b-41d4-a716-446655440004": {
            "_id": "990e8400-e29b-41d4-a716-446655440004",
            "clientId": "client123",
            "campaignId": {
                "_id": "550e8400-e29b-41d4-a716-446655440000",
                "name": "Summer Sale 2025"
            },
            "itemId": {
                "_id": "aa0e8400-e29b-41d4-a716-446655440007",
                "name": "Product Brochure",
                "posNumber": "BRO001",
                "elementId": {
                    "name": "Tri-fold Brochure"
                }
            },
            "status": 100,
            "qty": 0,
            "isLocked": false,
            "hasArtwork": false,
            "hasAllocations": false,
            "updatedAt": "2025-09-09T12:15:00Z"
        }
    },
    "totalCount": 47,
    "limit": 25,
    "skip": 0
}

Modified at 2025-09-25 10:04:16

Delete a campaign item

Create multiple campaign items