List campaign artworks with filtering

GET

/campaign-artworks

Retrieves a paginated list of campaign artworks with comprehensive filtering options.

Search Capabilities:

Search across artwork names, reference numbers, descriptions, and notes

Search through category names associated with artworks

Complex aggregation pipeline for cross-collection searches

Status Filtering:

Filter by imported POS element status

Include or exclude cancelled artworks

Combine status and cancellation filters

Features:

Populated artwork files and category information

Assigned artworker details

Campaign information with state

Category groups with tag population

Backward compatibility for category handling

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Query Params

Responses

🟢200OK

application/json

Campaign artworks retrieved successfully

Body

🟠400Bad Request

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://prod.your-api-server.com/campaign-artworks?limit=25&skip=0&sort=-updatedAt&search=holiday banner&status[]=100,104&isCancelled=false&campaignId=550e8400-e29b-41d4-a716-446655440000&assignedArtworker=550e8400-e29b-41d4-a716-446655440001' \
--header 'Authorization: <api-key>'

Response Example

200 - Example 1

{
    "campaignArtworkIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "campaignArtworkEntities": {
        "property1": {},
        "property2": {}
    },
    "totalCount": 0,
    "limit": 0,
    "skip": 0
}

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

Create campaign artworks in bulk

Update an existing campaign artwork