Skip to main content
GET
List Prospects With Statistics

Authorizations

X-API-Key
string
header
required

API Key for authentication

Query Parameters

campaignId
string<uuid>
required

ID of the campaign to list prospects from.

listId
string<uuid>

Optional prospect list ID to narrow the result to a single list within the campaign.

Response

status
enum<string>
required

Response status

Available options:
success
data
object[]
required

Prospects list with statistics

message
string
required

Success message

Example:

"Operation completed successfully"