Skip to main content
GET
/
api
/
v2
/
voice-campaigns
/
{campaign_id}
/
leads
/
list
List Leads in Campaign
curl --request GET \
  --url https://api.voiceaiwrapper.app/api/v2/voice-campaigns/{campaign_id}/leads/list \
  --header 'Authorization: Bearer <token>'
{
  "leads": [
    {
      "id": "Vm9pY2VDYW1wYWlnbkxlYWQ6YWJj",
      "phone_number": "+14155552671",
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane@example.com",
      "source": "API",
      "custom_fields": {
        "company": "Acme"
      },
      "call_status": "IDLE",
      "call_error_reason": null,
      "answered": false,
      "answer_type": "",
      "attempts_made": 0,
      "do_not_call": false,
      "invalid": false,
      "invalid_reason": null,
      "priority": 0,
      "next_attempt_after": null,
      "answered_at": null,
      "created_at": "2025-01-15T10:00:00+00:00",
      "updated_at": "2025-01-15T10:00:00+00:00"
    }
  ],
  "page_info": {
    "total_count": 100,
    "limit": 50,
    "offset": 0,
    "has_next_page": true,
    "has_previous_page": false
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaign_id
string
required

Campaign global ID. Required.

Example:

"VnVpc2VDYW1wYWlnbjoxMjM0"

Query Parameters

​
limit
integer
default:50

Maximum number of leads to return. Default 50, maximum 200.

Required range: 1 <= x <= 200
​
offset
integer
default:0

Number of leads to skip from the start of the result set. Default 0.

Required range: x >= 0

Response

Paginated list of leads and page_info (total count, limit, offset, and next/previous flags).

​
leads
object[]
required
​
page_info
object
required

Offset pagination metadata for the list request.