Zum Hauptinhalt springen
GET
/
api
/
user
/
leads
Leads auflisten
curl --request GET \
  --url https://app.famulor.de/api/user/leads \
  --header 'Authorization: Bearer <token>'
{
  "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
}
Dieser Endpunkt ermöglicht es Ihnen, alle Leads des authentifizierten Benutzers mit Filter- und Paginierungsoptionen aufzulisten.

​
Query Parameters

​
status
string
Leads nach Status filtern. Mögliche Werte: created, scheduled, processing, completed, rescheduled, reached-max-retries, blacklisted
​
campaign_id
integer
Leads nach Kampagnen-ID filtern
​
phone_number
string
Leads nach Telefonnummer filtern (Teiltreffer unterstützt)
​
date_from
string
Leads filtern, die ab diesem Datum erstellt wurden (YYYY-MM-DD Format)
​
date_to
string
Leads filtern, die bis zu diesem Datum erstellt wurden (YYYY-MM-DD Format)
​
per_page
integer
Standard:"15"
Anzahl der Leads pro Seite (1-100)
​
page
integer
Standard:"1"
Seitennummer

​
Antwort-Felder

​
data
array
Liste der Leads
​
current_page
integer
Die aktuelle Seitennummer
​
per_page
integer
Anzahl der Einträge pro Seite
​
total
integer
Gesamtanzahl der Leads, die den Kriterien entsprechen
​
last_page
integer
Die letzte Seitennummer
{
  "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
}
Passende Seiten: Introduction und Authentication Guide und API Integration Examples.