List leads | ElevenLabs Documentation

{
  "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
}

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.

searchstring or nullOptional<=100 characters

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

statusenum or nullOptional

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

Allowed values:

dispositionlist of enums or nullOptional

Only leads that finished in one of these ways.

cursorstring or nullOptional

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

Response

Successful Response

leadslist of objects

next_cursorstring or null

has_moreboolean

Errors

422

Unprocessable Entity Error

Path parameters

Headers

Query parameters

Response

Errors