Agents Platform

List Outbound Campaign Leads

Changed on

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

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

Request

Path parameters

campaign_idstring required

Query parameters

page_sizeinteger

How many items to return at most.

searchstring nullable

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

status'in_progress' | 'finished' nullable

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

dispositionTerminalDisposition[] nullable

Only leads that finished in one of these ways.

cursorstring nullable

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

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

next_cursorstring nullable required
has_moreboolean required

Changes