Get a single campaign

GET

/campaign/{id}

Retrieves detailed information for a specific campaign.

Features:

Complete campaign details with all fields

Populated user references (owner, creator, supplier, printer)

Element groups with populated element details

Notification template events with department information

Trading period information

Booking associations

Invite information

Publication status

Permissions:

User must have read access to the campaign

Respects campaign visibility rules

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Responses

🟢200OK

application/json

Campaign retrieved successfully

Body

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://prod.your-api-server.com/campaign/550e8400-e29b-41d4-a716-446655440000' \
--header 'Authorization: <api-key>'

Response Example

200 - Example 1

{
    "_id": "550e8400-e29b-41d4-a716-446655440000",
    "clientId": "client123",
    "name": "Q4 Holiday Campaign",
    "number": 2025001,
    "prefix": "HOL",
    "reference": "HOL-2025001",
    "shortReference": "HOL25",
    "status": 100,
    "state": 90,
    "isLocked": false,
    "isActive": true,
    "version": 0,
    "campaignType": [
        "holiday",
        "seasonal"
    ],
    "itemType": "retail",
    "department": [
        "marketing",
        "retail"
    ],
    "region": [
        "north",
        "south"
    ],
    "brand": [
        "brand1",
        "brand2"
    ],
    "priority": "high",
    "season": "Winter 2025",
    "month": "December",
    "year": "2025",
    "startAt": "2025-12-01T00:00:00Z",
    "endAt": "2025-12-31T23:59:59Z",
    "launchDate": "2025-12-15T00:00:00Z",
    "dueInStoreDate": "2025-12-10T00:00:00Z",
    "dispatchBy": "2025-12-08T00:00:00Z",
    "finishBy": "2025-12-05T00:00:00Z",
    "approvalDue": "2025-11-30T00:00:00Z",
    "approvedDate": "2025-11-28T00:00:00Z",
    "artworkDue": "2025-11-25T00:00:00Z",
    "quoteDue": "2025-11-20T00:00:00Z",
    "briefCompletionDate": "2025-11-15T00:00:00Z",
    "workCommencesDate": "2025-11-18T00:00:00Z",
    "kickOffMeetingDate": "2025-11-10T00:00:00Z",
    "signOffDate": "2025-12-20T00:00:00Z",
    "executionDate": "2025-12-12T00:00:00Z",
    "crExpirationDate": "2025-12-31T00:00:00Z",
    "kitArrivalDate": "2025-12-07T00:00:00Z",
    "beforeKitArrivalDate": "2025-12-06T00:00:00Z",
    "afterKitArrivalDate": "2025-12-08T00:00:00Z",
    "pickingDate": "2025-12-09T00:00:00Z",
    "stockDestructionBy": "2026-01-31T00:00:00Z",
    "isFinishByIrrelevant": false,
    "isStockDestructionByIrrelevant": false,
    "lastSentToPrinter": "2025-12-01T00:00:00Z",
    "sentToPrinter": "2025-12-01T00:00:00Z",
    "purchaseOrderNumber": "PO-2025-001",
    "posElementCounter": 0,
    "notes": "Special holiday promotion with extended hours",
    "meta": {},
    "defaults": {
        "departmentGroup": "retail",
        "fileCopy": 1,
        "oversType": "percent",
        "oversValue": 10,
        "rules": [
            {
                "property": "store",
                "rule": "include",
                "values": [
                    "string"
                ],
                "filters": [
                    {
                        "property": "string",
                        "ids": [
                            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                        ],
                        "values": [
                            "string"
                        ],
                        "rule": "string"
                    }
                ],
                "quantities": [
                    {
                        "property": "string",
                        "values": [
                            "string"
                        ],
                        "amounts": [
                            0
                        ]
                    }
                ]
            }
        ]
    },
    "priceMeta": {
        "packaging": 100.5,
        "delivery": 50.25,
        "additional": 25,
        "discount": 15.75,
        "installation": 200,
        "bumpOut": 75.5
    },
    "elementGroups": [
        {
            "elementId": "550e8400-e29b-41d4-a716-446655440000",
            "campaignItems": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "name": "string"
                }
            ]
        }
    ],
    "assetGroups": [
        {
            "assetId": "550e8400-e29b-41d4-a716-446655440000",
            "campaignItems": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "name": "string"
                }
            ]
        }
    ],
    "notificationTemplateEvents": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "isEventDate": true,
            "linkedEventId": "c5b911a2-a3f1-484d-a9a6-eb0d115510b0",
            "sendAtDays": 0,
            "sendNotifications": false,
            "attachSummaryReport": false,
            "recipients": [],
            "subject": "string",
            "message": "string",
            "departments": [],
            "date": "2019-08-24T14:15:22Z",
            "isSent": false,
            "notificationSentAt": "2019-08-24T14:15:22Z"
        }
    ],
    "tradingPeriodIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "segRuleIdsToGenerate": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "views": {
        "property1": {
            "property1": "2019-08-24T14:15:22Z",
            "property2": "2019-08-24T14:15:22Z"
        },
        "property2": {
            "property1": "2019-08-24T14:15:22Z",
            "property2": "2019-08-24T14:15:22Z"
        }
    },
    "ziflowFolderId": "ziflow-folder-123",
    "templateId": "template-123",
    "kittingId": "550e8400-e29b-41d4-a716-446655440000",
    "notificationTemplateId": "550e8400-e29b-41d4-a716-446655440000",
    "surveyId": "550e8400-e29b-41d4-a716-446655440000",
    "campaignItemsEditOnly": false,
    "isGeneratingItems": false,
    "postFederationAPI": false,
    "owner": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "ownerPrimary": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "createdBy": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "itemOwner": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "backupOwner": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "kitter": {
        "_id": "1f704bc5-5055-43eb-a851-c87b6b0bf7b9",
        "name": "string",
        "email": "user@example.com",
        "contact": "string"
    },
    "createdAt": "2025-09-09T10:00:00Z",
    "updatedAt": "2025-09-09T10:00:00Z"
}

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

Simple campaign listing

Archive multiple campaigns