Skip to content

Campaigns (Collection)

Campaign collection endpoint.

Endpoint

Method URL
GET /campaigns

GET /campaigns

Parameter Type Description
page int Result page. Defaults to 1.
pagesize int Max campaigns per page. Range [10, 100]. Defaults to 10.
sort string field,direction pair. Field can be any campaign field. Direction: ASC or DESC. Defaults to when,DESC.
state string Filter by campaign state. Defaults to all states.
q string Search string filter. Defaults to no filtering.

Returns: The campaign collection.

Example:

curl -u "username:api_key" -H "Accept: application/json" \
  "https://app.duo.pt/campaigns?page=1&pagesize=10&sort=when,DESC"

Response:

{
  "success": true,
  "data": {
    "filterByQuery": "true",
    "filterByOptions": [],
    "filterByField": null,
    "pageCount": 1,
    "campaigns": [
      {
        "id": 1,
        "owner": 1,
        "list": 1,
        "name": "Summer Newsletter 2026",
        "domain": 1,
        "segments": null,
        "recipients": null,
        "state": "DRAFT",
        "when": {
          "date": "...",
          "timezone_type": "...",
          "timezone": "..."
        },
        "event_callback": null
      }
    ],
    "page": 1
  }
}