API DocumentationCampaigns
Get Campaign Prospects
Get all prospects for a specific campaign.
Args: campaign_id: The ID of the campaign to get prospects for sort_by: Field to sort by. Options: name, phone sort_direction: Direction to sort. Options: asc (ascending), desc (descending)
AuthorizationBearer <token>
In: header
Path Parameters
campaign_idCampaign Id
Query Parameters
sort_by?Sort By
Default
"name"sort_direction?Sort Direction
Default
"asc"page?Page
Default
1Range
1 <= valuepage_size?Page Size
Response Body
curl -X GET "https://api.voxxi.ai/v1/campaigns/0/prospects?sort_by=name&sort_direction=asc&page=1&page_size=1"{
"items": [
{
"id": 0,
"name": "string",
"phone": "string",
"metadata": {}
}
],
"count": 0
}{
"detail": "string"
}{
"detail": "string"
}{
"detail": "string"
}{
"detail": [
{
"type": "string",
"loc": [
"string"
],
"msg": "string",
"ctx": {}
}
]
}{
"detail": "string"
}