---
title: "List campaigns"
slug: "docs-list-campaigns"
updated: 2024-10-25T14:42:06Z
published: 2024-10-25T14:42:06Z
canonical: "docs.voiso.com/docs-list-campaigns"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voiso.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List campaigns

The **List Campaigns** API is part of Voiso's Campaigns APIs. Use it to obtain a list of all campaign names, IDs, and other metadata. The API description is [here](/v1-api/apidocs/list-campaigns).

## Prerequisites

You must have at least one [campaign configured](https://docs.voiso.com/docs/outbound-dialer-campaigns-overview) for your contact center.

## Making requests

The **List_campaigns** API requires the [base URL](/v1-api/apidocs/base-endpoint) (cluster_id) and the [contact center API key](/v1-api/apidocs/authentication). The following table lists the optional filters you can use to refine your request.

| Parameter | Description | Type | Required | Notes |
| --- | --- | --- | --- | --- |
| filter[name] | A campaign name | string | Optional |  |
| filter[strategy] | A campaign strategy type | string | Optional | Valid values are: simple, advanced, and predictive_ai |
| filter[status] | The current status of the campaign | string | Optional | Valid values are: draft, active, paused, stopping, completed, processing, stopped, auto_paused, pausing, auto_pausing, import_error |
| filter[method] | The method of uploading numbers to the campaign | string | Optional | Valid values are: csv, bitrix_crm, dynamics_crm, falcon_crm, hubspot_crm, panda_crm, popcorn_crm, proftit_crm, puma_crm, salesforce_crm, and zoho_crm |
| filter[live] | Whether or not the campaign type is `live` | Boolean | Optional |  |

Make a request to return a list of campaigns. For example:

```
GET /api/dialer/v1/campaigns?filter[name]=campaign%20name&filter[strategy]=advanced&filter[status]=active&filter[method]=csv&filter[live]=false

HTTP/1.1
Host: cluster1.voiso.com
Accept: application/json
Authorization: Bearer token: 63c526cqwg05ce85e8bwtbt208943f93131c9d0d1d237b7c
```

JSON request example:

```
{
  "method": "GET",
  "url": "https://cluster1.voiso.com/api/dialer/v1/campaigns",
  "headers": {
    "Accept": "application/json",
    "Authorization": "Bearer 63c526cqwg05ce85e8bwtbt208943f93131c9d0d1d237b7c"
  },
  "params": {
    "filter[name]": "campaign name",
    "filter[strategy]": "advanced",
    "filter[status]": "active",
    "filter[method]": "csv",
    "filter[live]": "false"
  }
}
```

## Response

The following table describes the elements of the response.

| Element | Description | Type | Notes |
| --- | --- | --- | --- |
| id | The ID assigned to the campaign when it was created. | number | This number corresponds to the number in the ID column of the Dialer campaigns page. |
| name | The name of the campaign. | string |  |
| status | The current status of the campaign | string | Valid values are: draft, active, paused, stopping, completed, processing, stopped, auto_paused, pausing, auto_pausing, import_error |
| strategy | A campaign strategy type | string | Valid values are: simple, advanced, and predictive_ai |
| method | The method of uploading numbers to the campaign | string | Valid values are: csv, bitrix_crm, dynamics_crm, falcon_crm, hubspot_crm, panda_crm, popcorn_crm, proftit_crm, puma_crm, salesforce_crm, and zoho_crm |
| live | Whether or not the campaign type is `live` | Boolean |  |
| created_at | The date and time that the campaign was created. | string | ISO 8601 format |

### Response sample

```
{
    "campaigns": [
        {
            "id": 25735,
            "name": "Canada Campaign",
            "status": "paused",
            "strategy": "simple",
            "method": "file_import",
            "live": true,
            "created_at": "2023-10-20T13:06:09.310178+00:00"
        },
        {
            "id": 25473,
            "name": "Wasson Campaign October",
            "status": "completed",
            "strategy": "simple",
            "method": "hubspot_crm",
            "live": false,
            "created_at": "2023-10-03T13:33:28.746311+00:00"
    ]
    "metadata": {
        "limit": 25,
        "offset": 0,
        "total": 2
    }
}
```

## Troubleshooting

The following issues are sometimes encountered:

### The API key specified is invalid

The **List campaigns** API uses the contact center API key to validate the request. If you see this error, `"error": "Invalid API key"`, check that you are using the correct contact center API key. For more information about API keys, refer to [Authentication](/v1-api/apidocs/authentication).