Skip to main content
GET

List Campaigns

Retrieve a list of all campaigns for the authenticated environment with various filtering options and pagination support.

Endpoint

Request headers

string
required
Bearer token for authentication. Format: Bearer talq_your_environment_token_here

Query parameters

string
Filter by campaign status. Options: draft, active, paused, completed, cancelled
string
Filter by campaign type. Options: sales, follow_up, reminder, custom
string
Filter by agent ID
string
Filter campaigns from date (YYYY-MM-DD)
string
Filter campaigns to date (YYYY-MM-DD)
Search in campaign name or description
integer
Number of items per page (default: 20, max: 100)
integer
Page number (default: 1)

Example requests

Response

Success Response (200 OK)

Response fields

boolean
required
Indicates if the operation was successful.
array
required
Array of campaign objects.
object
required
Pagination metadata.

Error responses

401 Unauthorized

422 Validation Error

500 Server Error

Error codes

Important notes

Pagination support. All list endpoints support pagination with page and per_page parameters.
Date filtering. Use date_from and date_to to filter campaigns by date range.
Search functionality. The search parameter searches in campaign names and descriptions.
Statistics included. Each campaign includes real-time statistics about call performance.
  • Create Campaign: POST /api/v1/campaigns
  • Get Campaign: GET /api/v1/campaigns/{campaign_id}
  • Update Campaign: PUT /api/v1/campaigns/{campaign_id}
  • List Calls: GET /api/v1/calls