ELelevenlabs
Agents Platform

Get An Outbound Campaign Lead

Changed on

Get one lead of an outbound campaign.

get/v1/convai/outbound-campaigns/campaigns/{campaign_id}/leads/{lead_id}

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

campaign_idstring required
lead_idstring required

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

lead_idstring required
recipient_idstring nullable required

The id given to this recipient when the campaign was created.

phone_numberstring required

The number the lead's next call dials. It changes when the lead moves on to another listed number or the contact asks to be called on a different one.

phone_numbersstring[]

The lead's listed numbers, in calling order.

phone_numbers_indexinteger required

The position in phone_numbers of the number being called.

user_idstring required

The contact's identity: the user_id submitted in conversation_initiation_client_data, else the lead's phone number.

attempt_countinteger required

Calls placed, counted against the policy's max_total_calls.

failure_countinteger required

Failed calls to the current number; resets on a new number.

callback_countinteger required

Callbacks the contact asked for.

redirect_countinteger required

Times the contact asked to be called on another number.

do_not_callboolean required

Set when the contact asked not to be called, the lead was removed, or the campaign stopped. The lead isn't called again.

terminal_disposition'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' required
created_at_unixinteger nullable required

When the lead joined the campaign; unset on older leads.

updated_at_unixinteger required
dynamic_variablesobject required

The dynamic variables submitted for the lead, with secrets redacted.

Changes