> For the complete documentation index, see [llms.txt](https://docs-pt.sinch.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-pt.sinch.com/apidecampanhas/instrucoes-e-boas-praticas/listar-campanhas.md).

# Listar campanhas

Listagem das campanhas já cadastradas na plataforma. É possível paginar os resultados ou filtrar pelo nome da campanha.

`GET https://apigw.wavy.global/api/v1/campaigns`

#### Parâmetros da QueryString <a href="#par-metros-da-querystring" id="par-metros-da-querystring"></a>

\* Campo obrigatório

| Campo      | Detalhes                                         | Tipo    |
| ---------- | ------------------------------------------------ | ------- |
| name       | Nome de uma campanha como filtro para a listagem | String  |
| page       | Página a ser listada                             | Integer |
| page\_size | Total de campanhas por página                    | Integer |

> Exemplo de listagem de campanhas

{% tabs %}
{% tab title="cURL" %}

```
curl -X GET \
 'https://apigw.wavy.global/api/v1/campaigns?name=MyCampaign&page=1&page_size=10' \
 -H 'Content-Type: application/json' \
 -H 'authenticationToken: <authentication_token>' \
 -H 'userName: <e-mail>'
```

{% endtab %}
{% endtabs %}

> Resposta

{% tabs %}
{% tab title="cURL" %}

```
HEADERS:
page-number: 1
per-page: 10
total: 2
total-pages: 1
```

```
{
    "status": {
        "error": false
    },
    "campaigns": [
        {
            "name": "My first campaign",
            "id": 1,
            "alias": "first"
        },
        {
            "name": "My second campaign",
            "id": 2,
            "alias": "second"
        }
    ]
}
```

{% endtab %}

{% tab title="Ruby" %}

```
HEADERS:
page-number: 1
per-page: 10
total: 2
total-pages: 1
```

```
{
    "status": {
        "error": false
    },
    "campaigns": [
        {
            "name": "My first campaign",
            "id": 1,
            "alias": "first"
        },
        {
            "name": "My second campaign",
            "id": 2,
            "alias": "second"
        }
    ]
}
```

{% endtab %}

{% tab title="Python" %}

```
HEADERS:
page-number: 1
per-page: 10
total: 2
total-pages: 1
{
    "status": {
        "error": false
    },
    "campaigns": [
        {
            "name": "My first campaign",
            "id": 1,
            "alias": "first"
        },
        {
            "name": "My second campaign",
            "id": 2,
            "alias": "second"
        }
    ]
}
```

{% endtab %}

{% tab title="PHP" %}

```
HEADERS:
page-number: 1
per-page: 10
total: 2
total-pages: 1

{
    "status": {
        "error": false
    },
    "campaigns": [
        {
            "name": "My first campaign",
            "id": 1,
            "alias": "first"
        },
        {
            "name": "My second campaign",
            "id": 2,
            "alias": "second"
        }
    ]
}
```

{% endtab %}

{% tab title="Java" %}

```
HEADERS:
page-number: 1
per-page: 10
total: 2
total-pages: 1

{
    "status": {
        "error": false
    },
    "campaigns": [
        {
            "name": "My first campaign",
            "id": 1,
            "alias": "first"
        },
        {
            "name": "My second campaign",
            "id": 2,
            "alias": "second"
        }
    ]
}
```

{% endtab %}
{% endtabs %}