List leads

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id/leads

GET

/v1/convai/outbound-campaigns/campaigns/:campaign_id/leads

curl -G https://api.elevenlabs.io/v1/convai/outbound-campaigns/campaigns/campaign_id/leads \
     -d cursor=cursor \
     -d disposition=campaign_ended \
     -d page_size=1 \
     -d search=search \
     -d status=in_progress

{
  "leads": [
    {
      "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": {},
      "recipient_id": "recipient_id",
      "phone_numbers": [
        "phone_numbers"
      ],
      "terminal_disposition": "campaign_ended",
      "created_at_unix": 1,
      "delivery": {
        "status": "pending",
        "stage": "queued",
        "sent_at_unix": null,
        "delivered_at_unix": null,
        "read_at_unix": null,
        "replied_at_unix": null,
        "failed_at_unix": null,
        "error_message": null
      }
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

List the leads of an outbound campaign, one per recipient.

Path parameters

campaign_idstringRequired

Query parameters

page_sizeintegerOptional1-500Defaults to 100

How many items to return at most.

searchstringOptional<=100 characters

Only leads whose ID, user ID or phone number contains this text.

statusenumOptional

in_progress for leads still being called, finished for leads that won’t be called again.

Allowed values:

dispositionenumOptional

Only leads that finished in one of these ways.

cursorstringOptional

Used for fetching next page. Cursor is returned in the response.

Response

Successful Response

leadslist of objects

has_moreboolean

next_cursorstringOptional

Errors

422

Leads List Request Unprocessable Entity Error

Path parameters

Headers

Query parameters

Response

Errors