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

# Lister les leads

> Récupère une liste paginée de tous les leads du compte Famulor authentifié via l'API. Filtre, trie et donne accès aux détails de contact pour les campagnes de l'agent vocal.

<Warning>
  **API Famulor 1.0 (héritée).** Cette page concerne uniquement Famulor 1.0 (`app.famulor.de`) et est conservée pour la compatibilité. Pour la plateforme actuelle, consultez la [référence API Famulor 2.0](/fr/api-reference/introduction).
</Warning>

Ce point de terminaison vous permet de lister tous les leads appartenant à l'utilisateur authentifié, avec des options de filtrage et de pagination.

### Paramètres de requête

<ParamField query="status" type="string">
  Filtre les leads par statut. Valeurs possibles : `created`, `scheduled`, `processing`, `completed`, `rescheduled`, `reached-max-retries`, `blacklisted`
</ParamField>

<ParamField query="campaign_id" type="integer">
  Filtre les leads par identifiant de campagne
</ParamField>

<ParamField query="phone_number" type="string">
  Filtre les leads par numéro de téléphone (la correspondance partielle est prise en charge)
</ParamField>

<ParamField query="date_from" type="string">
  Filtre les leads créés à partir de cette date (format `YYYY-MM-DD`)
</ParamField>

<ParamField query="date_to" type="string">
  Filtre les leads créés jusqu'à cette date (format `YYYY-MM-DD`)
</ParamField>

<ParamField query="per_page" type="integer" default="15">
  Nombre de leads par page (`1-100`)
</ParamField>

<ParamField query="page" type="integer" default="1">
  Numéro de page
</ParamField>

### Champs de réponse

<ResponseField name="data" type="array">
  Liste des leads

  <Expandable title="Propriétés du lead">
    <ResponseField name="id" type="integer">
      L'identifiant du lead
    </ResponseField>

    <ResponseField name="campaign_id" type="integer">
      L'identifiant de la campagne à laquelle appartient ce lead
    </ResponseField>

    <ResponseField name="phone_number" type="string">
      Le numéro de téléphone du lead au format E.164
    </ResponseField>

    <ResponseField name="variables" type="object">
      Les variables attribuées au lead
    </ResponseField>

    <ResponseField name="status" type="string">
      Le statut du lead
    </ResponseField>

    <ResponseField name="created_at" type="string">
      La date de création du lead
    </ResponseField>

    <ResponseField name="updated_at" type="string">
      La date de la dernière mise à jour du lead
    </ResponseField>

    <ResponseField name="campaign" type="object">
      Les informations de la campagne

      <Expandable title="Propriétés de la campagne">
        <ResponseField name="id" type="integer">
          L'identifiant de la campagne
        </ResponseField>

        <ResponseField name="name" type="string">
          Le nom de la campagne
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="secondary_contacts" type="array">
      Tableau des leads de contacts secondaires liés à ce lead

      <Expandable title="Propriétés du contact secondaire">
        <ResponseField name="id" type="integer">
          L'identifiant du lead de contact secondaire
        </ResponseField>

        <ResponseField name="phone_number" type="string">
          Le numéro de téléphone du contact secondaire au format E.164
        </ResponseField>

        <ResponseField name="variables" type="object">
          Les variables attribuées au contact secondaire
        </ResponseField>

        <ResponseField name="status" type="string">
          Le statut du contact secondaire
        </ResponseField>

        <ResponseField name="created_at" type="string">
          La date de création du contact secondaire
        </ResponseField>

        <ResponseField name="updated_at" type="string">
          La date de la dernière mise à jour du contact secondaire
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="current_page" type="integer">
  Le numéro de la page actuelle
</ResponseField>

<ResponseField name="per_page" type="integer">
  Nombre d'éléments par page
</ResponseField>

<ResponseField name="total" type="integer">
  Nombre total de leads correspondant aux critères
</ResponseField>

<ResponseField name="last_page" type="integer">
  Le numéro de la dernière page
</ResponseField>

<ResponseExample>
  ```json 200 Response theme={null}
  {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "campaign_id": 1,
        "phone_number": "+1234567890",
        "variables": {
          "customer_name": "John Doe",
          "email": "john.doe@example.com"
        },
        "status": "created",
        "created_at": "2025-06-30 11:18:04",
        "updated_at": "2025-06-30 11:18:04",
        "campaign": {
          "id": 1,
          "name": "My new campaign"
        },
        "secondary_contacts": [
          {
            "id": 2,
            "phone_number": "+1234567899",
            "variables": {
              "customer_name": "Jane Doe Secondary",
              "email": "jane.doe.secondary@example.com"
            },
            "status": "created",
            "created_at": "2025-06-30 11:18:04",
            "updated_at": "2025-06-30 11:18:04"
          }
        ]
      }
    ],
    "first_page_url": "https://app.famulor.de/api/user/leads?page=1",
    "from": 1,
    "last_page": 10,
    "last_page_url": "https://app.famulor.de/api/user/leads?page=10",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://app.famulor.de/api/user/leads?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://app.famulor.de/api/user/leads?page=2",
        "label": "2",
        "active": false
      }
    ],
    "next_page_url": "https://app.famulor.de/api/user/leads?page=2",
    "path": "https://app.famulor.de/api/user/leads",
    "per_page": 15,
    "prev_page_url": null,
    "to": 15,
    "total": 150
  }
  ```
</ResponseExample>

<Tip>
  Pages associées : [Introduction](/fr/api-v1/introduction) et [Guide d'authentification](/fr/api-v1/authentication), et [Exemples d'intégration API](/fr/api-v1/introduction).
</Tip>