Skip to main content
GET
List campaigns
Use this endpoint to retrieve a paginated list of campaigns with optional filters.

Endpoint

GET /campaign-list Authentication: Required (workspace auth)

Query Parameters

Campaign Status Values

Response

Notes

  • campaign_status defaults to all statuses except deleted.
  • A campaign is automatically labeled Completed if its end_date has passed.
  • progress is formatted as called/total audience count.

Example cURL

Headers

token
string
required

API token for authentication

Query Parameters

page
integer

Page number (default: 1)

limit
integer

Records per page (default: 10)

agent_id
integer

Filter by agent ID

campaign_name
string

Partial name search (LIKE)

campaign_status
enum<string>

Filter by status. Defaults to all except deleted.

Available options:
draft,
inprogress,
hold,
pause,
force_completed,
deleted

Response

Campaign list retrieved successfully

datalist
object[]
pagination
object