> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt.

# Leads der Outbound-Kampagne auflisten

GET https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads

Listet die Leads einer Outbound-Kampagne auf, einen pro Empfänger.

Reference: https://elevenlabs.io/docs/api-reference/campaigns/leads/list

## Servers

- `https://api.elevenlabs.io` (Production, default)
- `https://api.us.elevenlabs.io` (Production US)
- `https://api.eu.residency.elevenlabs.io` (Production EU)
- `https://api.in.residency.elevenlabs.io` (Production India)
- `https://api.sg.residency.elevenlabs.io` (Production Singapore)

## Request

### Path parameters

- `campaign_id` (string, required)

### Query parameters

- `page_size` (integer, optional, default: 100) — Maximale Anzahl zurückzugebender Elemente.
- `search` (string, optional, nullable) — Nur Leads, deren ID, Benutzer-ID oder Telefonnummer diesen Text enthält.
- `status` (enum, optional, nullable) — `in_progress` für Leads, die noch angerufen werden, `finished` für Leads, die nicht erneut angerufen werden.
  - Allowed values: `in_progress`, `finished`
- `disposition` (list of enum, optional, nullable) — Nur Leads, die auf eine dieser Arten abgeschlossen wurden.
  - Allowed values: `campaign_ended`, `removed`, `do_not_call`, `completed`, `cancelled`, `suppressed`, `attempt_ceiling_reached`, `callback_ceiling_reached`, `redirect_ceiling_reached`, `permission_not_granted`, `permission_declined`, `permission_request_blocked`, `permission_expired`, `callback_time_invalid`, `redirect_number_invalid`, `couldnt_process`
- `cursor` (string, optional, nullable) — Wird zum Abrufen der nächsten Seite verwendet. Der Cursor wird in der Antwort zurückgegeben.

## Response

### 200

Erfolgreiche Antwort

- `leads` (list of LeadView, required)
- `next_cursor` (string, required, nullable)
- `has_more` (boolean, required)

## Errors

### 422 Unprocessable Entity Error

Validierungsfehler

- `detail` (list of ValidationError, optional)

## Types

### LeadView

- `lead_id` (string, required)
- `recipient_id` (string, required, nullable) — Die diesem Empfänger bei der Erstellung der Kampagne zugewiesene `id`.
- `phone_number` (string, required) — Die Nummer, die der nächste Anruf des Leads wählt. Sie ändert sich, wenn der Lead zu einer anderen angegebenen Nummer wechselt oder die Kontaktperson darum bittet, unter einer anderen Nummer angerufen zu werden.
- `phone_numbers_index` (integer, required) — Die Position der angerufenen Nummer in `phone_numbers`.
- `user_id` (string, required) — Die Identität der Kontaktperson: die in `conversation_initiation_client_data` übermittelte `user_id`, andernfalls die Telefonnummer des Leads.
- `attempt_count` (integer, required) — Getätigte Anrufe, die auf `max_total_calls` der Richtlinie angerechnet werden.
- `failure_count` (integer, required) — Fehlgeschlagene Anrufe an die aktuelle Nummer; wird bei einer neuen Nummer zurückgesetzt.
- `callback_count` (integer, required) — Von der Kontaktperson angeforderte Rückrufe.
- `redirect_count` (integer, required) — Anzahl der Fälle, in denen der Kontakt um einen Anruf unter einer anderen Nummer gebeten hat.
- `do_not_call` (boolean, required) — Wird gesetzt, wenn die Kontaktperson darum gebeten hat, nicht angerufen zu werden, der Lead entfernt wurde oder die Kampagne beendet wurde. Der Lead wird nicht erneut angerufen.
- `terminal_disposition` (enum, required, nullable) — Warum der Lead nicht erneut angerufen wird; nicht gesetzt, solange ein erneuter Anruf möglich ist.
  - Allowed values: `campaign_ended`, `removed`, `do_not_call`, `completed`, `cancelled`, `suppressed`, `attempt_ceiling_reached`, `callback_ceiling_reached`, `redirect_ceiling_reached`, `permission_not_granted`, `permission_declined`, `permission_request_blocked`, `permission_expired`, `callback_time_invalid`, `redirect_number_invalid`, `couldnt_process`
- `created_at_unix` (integer, required, nullable) — Zeitpunkt, zu dem der Lead der Kampagne beigetreten ist; bei älteren Leads nicht gesetzt.
- `updated_at_unix` (integer, required)
- `dynamic_variables` (map from string to any, required) — Die für den Lead übermittelten dynamischen Variablen mit geschwärzten Geheimnissen.
- `overrides` (FlattenedConfigOverrides, required) — Die für den Lead übermittelten Gesprächsüberschreibungen.
- `phone_numbers` (list of string, optional) — Die angegebenen Nummern des Leads in Anrufreihenfolge.
- `delivery` (LeadDeliveryView, optional, nullable) — Die letzte Nachrichtenzustellung des Leads; wird bei Nachrichtenkampagnen gesetzt.

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### FlattenedConfigOverrides

- `language` (string, optional, nullable)
- `first_message` (string, optional, nullable)
- `prompt` (string, optional, nullable)
- `voice_id` (string, optional, nullable)

### LeadDeliveryView

- `status` (enum, required)
  - Allowed values: `pending`, `dispatched`, `initiated`, `in_progress`, `completed`, `failed`, `cancelled`, `voicemail`
- `stage` (enum, required) — Die weiteste erreichte Zustellstufe der Nachricht oder `failed`, wenn das Senden fehlgeschlagen ist.
  - Allowed values: `queued`, `sent`, `delivered`, `read`, `replied`, `failed`
- `sent_at_unix` (integer, required, nullable)
- `delivered_at_unix` (integer, required, nullable)
- `read_at_unix` (integer, required, nullable)
- `replied_at_unix` (integer, required, nullable)
- `failed_at_unix` (integer, required, nullable)
- `error_message` (string, required, nullable) — Warum die Nachricht den Kontakt nicht erreicht hat.

### ValidationErrorLocItems

- string
- integer

## Examples

**Response**

```json
{
  "leads": [
    {
      "lead_id": "string",
      "recipient_id": "string",
      "phone_number": "string",
      "phone_numbers_index": 1,
      "user_id": "string",
      "attempt_count": 1,
      "failure_count": 1,
      "callback_count": 1,
      "redirect_count": 1,
      "do_not_call": true,
      "terminal_disposition": "campaign_ended",
      "created_at_unix": 1,
      "updated_at_unix": 1,
      "dynamic_variables": {},
      "overrides": {
        "language": "string",
        "first_message": "string",
        "prompt": "string",
        "voice_id": "string"
      },
      "phone_numbers": [
        "string"
      ],
      "delivery": {
        "status": "pending",
        "stage": "queued",
        "sent_at_unix": 1,
        "delivered_at_unix": 1,
        "read_at_unix": 1,
        "replied_at_unix": 1,
        "failed_at_unix": 1,
        "error_message": "string"
      }
    }
  ],
  "next_cursor": "string",
  "has_more": true
}
```

**SDK Code**

```python
import requests

url = "https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads"

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```