> 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.

# Elenca i lead della campagna outbound

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

Elenca i lead di una campagna in uscita, uno per destinatario.

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) — Numero massimo di elementi da restituire.
- `search` (string, optional, nullable) — Solo i lead il cui ID, ID utente o numero di telefono contiene questo testo.
- `status` (enum, optional, nullable) — `in_progress` per i lead ancora in fase di chiamata, `finished` per i lead che non verranno più chiamati.
  - Allowed values: `in_progress`, `finished`
- `disposition` (list of enum, optional, nullable) — Solo i lead completati in uno di questi modi.
  - 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) — Usato per recuperare la pagina successiva. Il cursore viene restituito nella risposta.

## Response

### 200

Risposta riuscita

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

## Errors

### 422 Unprocessable Entity Error

Errore di convalida

- `detail` (list of ValidationError, optional)

## Types

### LeadView

- `lead_id` (string, required)
- `recipient_id` (string, required, nullable) — L'`id` assegnato a questo destinatario alla creazione della campagna.
- `phone_number` (string, required) — Il numero composto dalla prossima chiamata del lead. Cambia quando il lead passa a un altro numero nell'elenco o il contatto chiede di essere chiamato su un numero diverso.
- `phone_numbers_index` (integer, required) — La posizione in `phone_numbers` del numero chiamato.
- `user_id` (string, required) — L'identità del contatto: l'`user_id` inviato in `conversation_initiation_client_data`, altrimenti il numero di telefono del lead.
- `attempt_count` (integer, required) — Chiamate effettuate, conteggiate rispetto a `max_total_calls` della policy.
- `failure_count` (integer, required) — Chiamate non riuscite al numero attuale; il conteggio si reimposta con un nuovo numero.
- `callback_count` (integer, required) — Richiamate richieste dal contatto.
- `redirect_count` (integer, required) — Le volte in cui il contatto ha chiesto di essere richiamato a un altro numero.
- `do_not_call` (boolean, required) — Impostato quando il contatto ha chiesto di non essere chiamato, il lead è stato rimosso o la campagna è stata interrotta. Il lead non verrà più chiamato.
- `terminal_disposition` (enum, required, nullable) — Perché il lead non verrà più chiamato; non impostato finché può ancora esserlo.
  - 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) — Quando il lead è entrato nella campagna; non impostato per i lead meno recenti.
- `updated_at_unix` (integer, required)
- `dynamic_variables` (map from string to any, required) — Le variabili dinamiche inviate per il lead, con i segreti oscurati.
- `overrides` (FlattenedConfigOverrides, required) — Gli override della conversazione inviati per il lead.
- `phone_numbers` (list of string, optional) — I numeri elencati del lead, nell'ordine di chiamata.
- `delivery` (LeadDeliveryView, optional, nullable) — L'ultima consegna di messaggi del lead; impostata nelle campagne di messaggi.

### 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) — La fase più avanzata raggiunta dal messaggio, oppure `failed` se l'invio non è riuscito.
  - 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) — Perché il messaggio non è riuscito a raggiungere il contatto.

### 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()
```