Skip to main content
GET
/
api
/
campaigns
/
campaigns
Get campaigns with pagination and filtering
curl --request GET \
  --url https://apiv1.delightloop.ai/api/campaigns/campaigns \
  --header 'x-api-key: <x-api-key>'
{
  "campaigns": [
    {
      "campaignId": "<string>",
      "organizationId": "<string>",
      "createdBy": "<string>",
      "status": "draft",
      "campaignData": {},
      "isDeleted": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "lastUpdatedBy": "<string>",
      "reason": "<string>",
      "name": "<string>",
      "description": "<string>",
      "totalRecipients": 123,
      "liveData": {},
      "completionData": {}
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "hasNext": true,
    "hasPrev": true
  }
}

Headers

x-api-key
string
required

auth key

Query Parameters

page
number
default:1

Page number for pagination

Required range: x >= 1
limit
number
default:12

Number of items per page

Required range: 1 <= x <= 100
status
enum<string>

Filter by campaign status

Available options:
draft,
in_progress,
preparing,
live,
completed

Search in campaign name or description

createdFrom
string

Filter campaigns created from this date (ISO 8601)

createdTo
string

Filter campaigns created until this date (ISO 8601)

sortBy
enum<string>
default:createdAt

Sort by field

Available options:
createdAt,
updatedAt,
name,
status
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
myCampaigns
boolean

Filter to show only campaigns created by current user

Response

200 - application/json

Campaigns retrieved successfully

campaigns
object[]
required

List of campaigns

pagination
object
required

Pagination metadata