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

# Listar leads

> Listar todos os leads para o usuário autenticado com opções de filtragem e paginação.

Este endpoint permite listar todos os leads pertencentes ao usuário autenticado com várias opções de filtragem e paginação.

### Parâmetros de Consulta

<ParamField query="status" type="string" optional>
  Filtrar leads por status. Valores possíveis: `created`, `scheduled`, `processing`, `completed`, `rescheduled`, `reached-max-retries`, `blacklisted`
</ParamField>

<ParamField query="campaign_id" type="integer" optional>
  Filtrar leads por ID da campanha
</ParamField>

<ParamField query="phone_number" type="string" optional>
  Filtrar leads por número de telefone (correspondência parcial suportada)
</ParamField>

<ParamField query="date_from" type="string" optional>
  Filtrar leads criados a partir desta data (formato YYYY-MM-DD)
</ParamField>

<ParamField query="date_to" type="string" optional>
  Filtrar leads criados até esta data (formato YYYY-MM-DD)
</ParamField>

<ParamField query="per_page" type="integer" optional>
  Número de leads por página (1-100, padrão: 15)
</ParamField>

<ParamField query="page" type="integer" optional>
  Número da página (padrão: 1)
</ParamField>

### Campos de Resposta

<ResponseField name="data" type="array">
  <Expandable title="propriedades">
    <ResponseField name="id" type="integer">
      O ID do lead
    </ResponseField>

    <ResponseField name="campaign_id" type="integer">
      O ID da campanha à qual este lead pertence
    </ResponseField>

    <ResponseField name="phone_number" type="string">
      O número de telefone do lead no formato E.164
    </ResponseField>

    <ResponseField name="variables" type="object">
      As variáveis associadas ao lead
    </ResponseField>

    <ResponseField name="status" type="string">
      O status do lead
    </ResponseField>

    <ResponseField name="created_at" type="string">
      A data de criação do lead
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      A data de atualização do lead
    </ResponseField>

    <ResponseField name="campaign" type="object">
      As informações da campanha

      <Expandable title="propriedades da campanha">
        <ResponseField name="id" type="integer">
          O ID da campanha
        </ResponseField>

        <ResponseField name="name" type="string">
          O nome da campanha
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="secondary_contacts" type="array">
      Array de leads de contatos secundários associados a este lead

      <Expandable title="propriedades de secondary_contacts">
        <ResponseField name="id" type="integer">
          O ID do lead de contato secundário
        </ResponseField>

        <ResponseField name="phone_number" type="string">
          O número de telefone do contato secundário no formato E.164
        </ResponseField>

        <ResponseField name="variables" type="object">
          As variáveis associadas ao contato secundário
        </ResponseField>

        <ResponseField name="status" type="string">
          O status do contato secundário
        </ResponseField>

        <ResponseField name="created_at" type="string">
          A data de criação do contato secundário
        </ResponseField>

        <ResponseField name="updated_at" type="string">
          A data de atualização do contato secundário
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="current_page" type="integer">
  O número da página atual
</ResponseField>

<ResponseField name="per_page" type="integer">
  Número de itens por página
</ResponseField>

<ResponseField name="total" type="integer">
  Número total de leads que correspondem aos critérios
</ResponseField>

<ResponseField name="last_page" type="integer">
  O número da última página
</ResponseField>

<ResponseExample>
  ```json 200 Response theme={null}
  {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "campaign_id": 1,
        "phone_number": "+1234567890",
        "variables": {
          "customer_name": "João Silva",
          "email": "joao.silva@exemplo.com"
        },
        "status": "created",
        "created_at": "2025-06-30 11:18:04",
        "updated_at": "2025-06-30 11:18:04",
        "campaign": {
          "id": 1,
          "name": "Minha nova campanha"
        },
        "secondary_contacts": [
          {
            "id": 2,
            "phone_number": "+1234567899",
            "variables": {
              "customer_name": "Maria Silva Secundária",
              "email": "maria.silva.secundaria@exemplo.com"
            },
            "status": "created",
            "created_at": "2025-06-30 11:18:04",
            "updated_at": "2025-06-30 11:18:04"
          }
        ]
      }
    ],
    "first_page_url": "https://suasofia.online/api/user/leads?page=1",
    "from": 1,
    "last_page": 10,
    "last_page_url": "https://suasofia.online/api/user/leads?page=10",
    "links": [
      {
        "url": null,
        "label": "&laquo; Anterior",
        "active": false
      },
      {
        "url": "https://suasofia.online/api/user/leads?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://suasofia.online/api/user/leads?page=2",
        "label": "2",
        "active": false
      }
    ],
    "next_page_url": "https://suasofia.online/api/user/leads?page=2",
    "path": "https://suasofia.online/api/user/leads",
    "per_page": 15,
    "prev_page_url": null,
    "to": 15,
    "total": 150
  }
  ```
</ResponseExample>