# ads.list

Listar anúncios que trouxeram pessoas. Anúncios de origem da conta atual com quantas pessoas chegaram por eles. Conta cada contato uma vez, no anúncio da sua primeira indicação. `from` e `to` (data ISO) limitam pela data dessa primeira indicação. Com `lookupStatus` diferente de `ok` os nomes ficam nulos e valem `headline`, `thumbnailUrl` e `permalinkUrl` vindos da mensagem. Ordenado por pessoas.

- Endpoint: `POST https://app.atomiks.com.br/api/v1/ads.list` (corpo JSON)
- Quem pode chamar: membro da conta
- Escopo da chave: `ads:read`
- Grava dados: não
- Pela chave de API: sim
- Ferramenta MCP: `ads_list`
- Ficha em JSON: `https://app.atomiks.com.br/api/v1/openapi.json` (operationId `ads.list`)

## Entrada

| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
| `from` | string | não |  |
| `to` | string | não |  |

<details><summary>JSON Schema</summary>

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "minLength": 8,
      "maxLength": 40
    },
    "to": {
      "type": "string",
      "minLength": 8,
      "maxLength": 40
    }
  }
}
```

</details>

## Exemplo

```bash
curl -X POST https://app.atomiks.com.br/api/v1/ads.list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"2026-10-01"}'
```

CLI:

```bash
node cli/atomiks.mjs ads.list --json '{"from":"2026-10-01"}'
```

MCP: ferramenta `ads_list` com a mesma entrada.

## Saída

Sucesso: `{"data": ...}` com o formato abaixo.

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "adId": {
        "type": "string"
      },
      "name": {
        "type": [
          "string",
          "null"
        ]
      },
      "adsetName": {
        "type": [
          "string",
          "null"
        ]
      },
      "campaignName": {
        "type": [
          "string",
          "null"
        ]
      },
      "headline": {
        "type": [
          "string",
          "null"
        ]
      },
      "people": {
        "type": "number"
      },
      "firstAt": {
        "type": "string"
      },
      "lastAt": {
        "type": "string"
      },
      "thumbnailUrl": {
        "type": [
          "string",
          "null"
        ]
      },
      "permalinkUrl": {
        "type": [
          "string",
          "null"
        ]
      },
      "lookupStatus": {
        "type": "string",
        "enum": [
          "pending",
          "ok",
          "not_matched",
          "error"
        ]
      }
    },
    "required": [
      "adId",
      "name",
      "adsetName",
      "campaignName",
      "headline",
      "people",
      "firstAt",
      "lastAt",
      "thumbnailUrl",
      "permalinkUrl",
      "lookupStatus"
    ],
    "additionalProperties": false
  }
}
```

## Erros

`{"error": {"code", "message", "requestId"}}`. Códigos: `invalid_input` (400), `unauthorized` (401), `forbidden` / `account_pending` / `scope_missing` (403), `not_found` (404), `limit_reached` (409), `internal` (500).