List Campaign Prospects
curl --request GET \
--url https://api.kakiyo.com/v1/prospects/campaign/{campaignId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.kakiyo.com/v1/prospects/campaign/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.kakiyo.com/v1/prospects/campaign/{campaignId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kakiyo.com/v1/prospects/campaign/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "chat_12345abcde",
"status": 2,
"qualification": "inProgress",
"paused": false,
"lastMessage": "2023-06-15T15:30:00Z",
"prospect": {
"id": "prospect_12345abcde",
"name": "John Smith",
"url": "https://linkedin.com/in/johnsmith",
"headline": "VP of Sales at Acme Inc",
"currentCompanyName": "Acme Inc",
"currentJobTitle": "VP of Sales",
"currentCompanyWebsite": "https://www.acme.com",
"currentCompanyLinkedInUrl": "https://www.linkedin.com/company/acme"
}
}
]{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}Prospects
List campaign prospects
Returns all prospects associated with a campaign
GET
/
prospects
/
campaign
/
{campaignId}
List Campaign Prospects
curl --request GET \
--url https://api.kakiyo.com/v1/prospects/campaign/{campaignId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.kakiyo.com/v1/prospects/campaign/{campaignId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.kakiyo.com/v1/prospects/campaign/{campaignId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kakiyo.com/v1/prospects/campaign/{campaignId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "chat_12345abcde",
"status": 2,
"qualification": "inProgress",
"paused": false,
"lastMessage": "2023-06-15T15:30:00Z",
"prospect": {
"id": "prospect_12345abcde",
"name": "John Smith",
"url": "https://linkedin.com/in/johnsmith",
"headline": "VP of Sales at Acme Inc",
"currentCompanyName": "Acme Inc",
"currentJobTitle": "VP of Sales",
"currentCompanyWebsite": "https://www.acme.com",
"currentCompanyLinkedInUrl": "https://www.linkedin.com/company/acme"
}
}
]{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}{
"error": "validation_error",
"message": "The request parameters failed validation",
"details": [
{
"field": "name",
"message": "The name field is required"
}
]
}Overview
List prospects for a specific campaign. The endpoint reads campaign conversation state from Appwrite and hydrates prospect profile details from PlanetScale. The response body remains a plain array for compatibility with existing integrations. Pagination metadata is returned in response headers. Eachprospect object includes current company data when available: currentCompanyName, currentJobTitle, currentCompanyWebsite, and currentCompanyLinkedInUrl.
Response Fields
string | null
Current company name from prospect enrichment.
string | null
Current job title from prospect enrichment.
string | null
Current company’s website URL when available.
string | null
Current company’s LinkedIn page URL when available.
Query Parameters
number
default:"25"
Maximum number of prospects to return. The maximum supported value is
100.number
default:"0"
Number of prospects to skip when using offset pagination. Ignored when
cursor is provided.string
Opaque cursor from the
X-Next-Cursor response header. Use this for stable pagination through large campaigns.number
Filter by conversation status. Use
4 to retrieve prospects who replied.boolean
Filter paused or active campaign conversations.
boolean
Filter conversations with or without a recorded last message timestamp. Use
status=4 when you specifically need replied prospects.Conversation Status Values
| Status | Meaning |
|---|---|
0 | Not started |
1 | Invitation sent |
2 | Invitation accepted |
3 | Contacted |
4 | Replied |
5 | Qualified |
6 | Unqualified |
7 | Skipped |
502 | Invites disabled |
503 | Unreachable |
504 | No longer in network |
505 | Invite cooldown |
Pagination Headers
| Header | Description |
|---|---|
X-Limit | Applied page size |
X-Offset | Applied offset when offset pagination is used |
X-Has-More | true when another page is available |
X-Next-Cursor | Opaque cursor to pass as cursor for the next page |
Examples
List campaign prospects
curl "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}?limit=100" \
-H "Authorization: Bearer YOUR_API_KEY"
List replied prospects
curl "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}?status=4&limit=100" \
-H "Authorization: Bearer YOUR_API_KEY"
List paused replied prospects
curl "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}?status=4&isPaused=true&limit=100" \
-H "Authorization: Bearer YOUR_API_KEY"
Continue with cursor pagination
curl "https://api.kakiyo.com/v1/prospects/campaign/{campaignId}?limit=100&cursor={nextCursor}" \
-H "Authorization: Bearer YOUR_API_KEY"
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the campaign
Response
List of prospects
Example:
"chat_12345abcde"
Available options:
0, 1, 2, 3, 4, 5 Example:
2
Available options:
unqualified, needVerification, inProgress, qualified Example:
"inProgress"
Example:
false
Example:
"2023-06-15T15:30:00Z"
Show child attributes
Show child attributes
Last modified on May 19, 2026

