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

# Een lead van uitgaande campagne ophalen

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

Haal één lead van een uitgaande campagne op.

Reference: https://elevenlabs.io/docs/eleven-agents/api-reference/campaigns/leads/get

## 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)
- `lead_id` (string, required)

## Response

### 200

Geslaagde response

- `lead_id` (string, required)
- `phone_number` (string, required) — Het nummer dat de volgende oproep van de lead belt. Dit verandert wanneer de lead doorgaat naar een ander opgegeven nummer of de contactpersoon vraagt om op een ander nummer te worden gebeld.
- `phone_numbers_index` (integer, required) — De positie in `phone_numbers` van het nummer dat wordt gebeld.
- `user_id` (string, required) — De identiteit van de contactpersoon: de `user_id` die is ingediend in `conversation_initiation_client_data`, anders het telefoonnummer van de lead.
- `attempt_count` (integer, required) — Geplaatste oproepen, meegeteld voor `max_total_calls` van het beleid.
- `failure_count` (integer, required) — Mislukte oproepen naar het huidige nummer; wordt gereset bij een nieuw nummer.
- `callback_count` (integer, required) — Terugbelverzoeken van de contactpersoon.
- `redirect_count` (integer, required) — Het aantal keren dat de contactpersoon vroeg om op een ander nummer te worden gebeld.
- `do_not_call` (boolean, required) — Ingesteld wanneer de contactpersoon heeft gevraagd niet te worden gebeld, de lead is verwijderd of de campagne is gestopt. De lead wordt niet opnieuw gebeld.
- `updated_at_unix` (integer, required)
- `dynamic_variables` (map from string to any, required) — De dynamische variabelen die voor de lead zijn ingediend, waarbij geheimen zijn weggelaten.
- `overrides` (FlattenedConfigOverrides, required) — De gespreksoverschrijvingen die voor de lead zijn ingediend.
- `recipient_id` (string, optional) — De `id` die aan deze ontvanger is gegeven toen de campagne werd gemaakt.
- `phone_numbers` (list of string, optional) — De opgegeven nummers van de lead, in belvolgorde.
- `terminal_disposition` (enum, optional) — Waarom de lead niet opnieuw wordt gebeld; niet ingesteld zolang dit nog mogelijk is.
  - 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, optional) — Wanneer de lead aan de campagne is toegevoegd; niet ingesteld voor oudere leads.
- `delivery` (LeadDeliveryView, optional) — De meest recente berichtbezorging van de lead; ingesteld bij berichtencampagnes.

## Errors

### 422 Leads Get Request Unprocessable Entity Error

Validatiefout

- `detail` (list of ValidationError, optional)

## Types

### FlattenedConfigOverrides

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

### LeadDeliveryView

- `status` (enum, required)
  - Allowed values: `pending`, `dispatched`, `initiated`, `in_progress`, `completed`, `failed`, `cancelled`, `voicemail`
- `stage` (enum, required) — De verst bereikte fase van het bericht, of `failed` als het verzenden is mislukt.
  - Allowed values: `queued`, `sent`, `delivered`, `read`, `replied`, `failed`
- `sent_at_unix` (integer, optional)
- `delivered_at_unix` (integer, optional)
- `read_at_unix` (integer, optional)
- `replied_at_unix` (integer, optional)
- `failed_at_unix` (integer, optional)
- `error_message` (string, optional) — Waarom het bericht de contactpersoon niet heeft bereikt.

### ValidationError

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

### ValidationErrorLocItem

- string
- integer

## Examples

**Response**

```json
{
  "lead_id": "lead_id",
  "phone_number": "phone_number",
  "phone_numbers_index": 1,
  "user_id": "user_id",
  "attempt_count": 1,
  "failure_count": 1,
  "callback_count": 1,
  "redirect_count": 1,
  "do_not_call": true,
  "updated_at_unix": 1,
  "dynamic_variables": {
    "key": "value"
  },
  "overrides": {
    "language": "language",
    "first_message": "first_message",
    "prompt": "prompt",
    "voice_id": "voice_id"
  },
  "recipient_id": "recipient_id",
  "phone_numbers": [
    "phone_numbers"
  ],
  "terminal_disposition": "campaign_ended",
  "created_at_unix": 1,
  "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": "error_message"
  }
}
```

**SDK Code**

```python
import requests

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

response = requests.get(url)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads/lead_id';
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/lead_id"

	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/lead_id")

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/lead_id")
  .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/lead_id');

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

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads/lead_id");
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/lead_id")! 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()
```