Skip to main content

List Campaigns

GET 
/api/communication/campaigns/

Retrieve a paginated list of campaigns for the authenticated user's entity.

Available Filters (Query Params)​

  • status → Filter by one or more status IDs. Example: ?status=1&status=2

  • channel → Filter by one or more channel values (case-insensitive: SMS, Email, WhatsApp, Telegram, Voice, All). Example: ?channel=SMS&channel=Email

  • sender_id → Filter by one or more sender IDs. Example: ?sender_id=1&sender_id=2&sender_id=3

  • target_id → Filter by one or more target audience IDs. Example: ?target_id=1&target_id=5

  • search → Search across: campaign_name, sender_name.name, target_audience.name, subject_line, and body.

  • ordering → Sort by any campaign field (e.g. created_at, send_date, campaign_name). Prefix with - for descending. Example: ?ordering=-created_at

All filters are optional and can be combined.

Combined Example​

?channel=SMS&channel=Email&sender_id=1&sender_id=2&ordering=-created_at

Request​

Responses​