Get campaigns

GET

/brand-api/resource/campaigns

Retrieves a list of campaigns for a brand.
You'll see the previous campaigns and the render status of each campaign.
You can download the campaign via the download_url once it's ready .

Request

Authorization

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://api.withdipp.com/brand-api/resource/campaigns?brand_uuid=&page=1&page_size=10' \
--header 'X-API-KEY: <api-key>'

Responses

🟢200OK

application/json

Error

Body

Example

{
    "campaigns": [
        {
            "uuid": "2bcabf00-33ef-4c87-8055-9ac1761c08f1",
            "name": "campaign name",
            "created_at": 1234567890,
            "created_by": "user name",
            "layout_uuid": "74dcc290-4a35-437a-afd6-e0bdf691445e",
            "layout_name": "layout name",
            "render_state": "render_success",
            "preview_url": "http://example.com",
            "download_url": "http://example.com"
        }
    ],
    "meta": {
        "page": 1,
        "page_size": 10,
        "total_count": 100,
        "total_pages": 10
    }
}

🟢200Success

🟠400Bad Request

Modified at 2025-08-29 07:22:38

Create campaign

Download product bundle image by data