Listar Campañas
Returns all Campaigns for your organization
startDate/endDate son nombres antiguos que se mantienen por compatibilidad y equivalen a createdAfter/createdBefore (filtran sobre created_at, no sobre cuándo inició o finalizó la Campaña). Usa startedAfter/startedBefore y endedAfter/endedBefore para filtrar por esas fechas. Cuando se envían ambos extremos de un par, el valor after debe ser anterior al before.Autorizaciones
Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.
Parámetros de consulta
Filters the Campaigns by Agent ID of the agent assigned to the Campaign
Filters the Campaigns by the Status of the Campaign
pending, ready, active, inactive, cooldown, finished Type of integration for the Campaign
phone_call, whatsapp Older name kept for backward compatibility, equivalent to createdAfter. Filters by created_at, not by start date.
Older name kept for backward compatibility, equivalent to createdBefore. Filters by created_at, not by end date.
Filter by created_at on or after this date.
Filter by created_at on or before this date.
Filter by started_at on or after this date. Excludes Campaigns that have not started.
Filter by started_at on or before this date. Excludes Campaigns that have not started.
Filter by ended_at on or after this date. Excludes Campaigns that have not ended.
Filter by ended_at on or before this date. Excludes Campaigns that have not ended.
If true, archived Campaigns will be included in the results.
Number of items per page to return.
x <= 100Cursor to the next page to return.
Respuesta
Campaigns response
Total number of Campaigns for the given query. NOTE: The result is cache for 3 minutes.
Filters are applied to each request independently. Changing filters while paginating may result in gaps or overlaps in the result set. For consistent results, maintain the same filters throughout pagination.