List leads
curl --request GET \
--url https://inboxapp.com/api/v1/campaigns/{campaignId}/leads \
--header 'Authorization: Bearer <token>'import requests
url = "https://inboxapp.com/api/v1/campaigns/{campaignId}/leads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://inboxapp.com/api/v1/campaigns/{campaignId}/leads', 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://inboxapp.com/api/v1/campaigns/{campaignId}/leads",
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://inboxapp.com/api/v1/campaigns/{campaignId}/leads"
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://inboxapp.com/api/v1/campaigns/{campaignId}/leads")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://inboxapp.com/api/v1/campaigns/{campaignId}/leads")
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{
"data": [
{
"prospect": {
"platform": "twitter",
"platformId": "<string>",
"externalId": "l44e15irdq4db30i77cgphhx",
"documentId": 858224163,
"displayName": "<string>",
"username": "<string>",
"handle": "<string>",
"image": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
"imageNormalized": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
"bio": "Social Selling CRM Close deals faster, stay organized, and never miss an opportunity. Starting with X",
"location": "San Francisco, CA",
"profileUrl": "<string>",
"websiteUrl": "https://inboxapp.com",
"websiteDomain": "inboxapp.com",
"isProtected": true,
"followerCount": 123,
"followingCount": 123,
"postCount": 123,
"engagementCount": 2613,
"listedCount": 18,
"platformCreatedAt": "2022-09-03T17:58:06.000Z",
"firstSeenAt": "2024-07-09T14:08:49.000Z",
"lastUpdatedAt": "2023-11-07T05:31:56Z",
"lastEnrichedAt": "2025-11-10T18:03:16.000Z",
"lastActiveAt": "2025-11-10T12:00:00.000Z",
"isFresh": true,
"isStale": true,
"confidence": 0.5,
"platformData": {
"isVerifiedBlue": true,
"isVerifiedGold": true,
"isVerifiedGray": true,
"professionalCategory": "986",
"urlEntities": [
{
"url": "<string>",
"expandedUrl": "<string>",
"displayUrl": "<string>",
"indices": [
123,
123
]
}
],
"bannerUrl": "https://pbs.twimg.com/profile_banners/1566123362161725440/1753273968",
"tweetsCount": 123,
"favoritesCount": 123,
"rawData": {}
}
},
"context": {
"tags": [
"<string>"
],
"statusId": "df6jbw4h36...",
"valuation": 599,
"notes": "This prospect is a potential customer.",
"threads": [
{
"id": "<string>",
"accountLinkId": "<string>",
"lastMessageTimestamp": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
]
},
"data": {
"custom_q5cktl47a6pqa74eu06fz89v": "Acme Corp",
"custom_m8r2xj93hd5bk0atcw7oe4fp": "CEO"
},
"accountLinkId": "<string>",
"threadId": "<string>"
}
],
"nextCursor": "<string>"
}Campaigns
List leads
List campaign leads with cursor-based pagination, optional filters, search, and sorting. Returns full prospect data including CRM context, custom column values, and campaign stage.
GET
/
campaigns
/
{campaignId}
/
leads
List leads
curl --request GET \
--url https://inboxapp.com/api/v1/campaigns/{campaignId}/leads \
--header 'Authorization: Bearer <token>'import requests
url = "https://inboxapp.com/api/v1/campaigns/{campaignId}/leads"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://inboxapp.com/api/v1/campaigns/{campaignId}/leads', 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://inboxapp.com/api/v1/campaigns/{campaignId}/leads",
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://inboxapp.com/api/v1/campaigns/{campaignId}/leads"
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://inboxapp.com/api/v1/campaigns/{campaignId}/leads")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://inboxapp.com/api/v1/campaigns/{campaignId}/leads")
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{
"data": [
{
"prospect": {
"platform": "twitter",
"platformId": "<string>",
"externalId": "l44e15irdq4db30i77cgphhx",
"documentId": 858224163,
"displayName": "<string>",
"username": "<string>",
"handle": "<string>",
"image": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
"imageNormalized": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
"bio": "Social Selling CRM Close deals faster, stay organized, and never miss an opportunity. Starting with X",
"location": "San Francisco, CA",
"profileUrl": "<string>",
"websiteUrl": "https://inboxapp.com",
"websiteDomain": "inboxapp.com",
"isProtected": true,
"followerCount": 123,
"followingCount": 123,
"postCount": 123,
"engagementCount": 2613,
"listedCount": 18,
"platformCreatedAt": "2022-09-03T17:58:06.000Z",
"firstSeenAt": "2024-07-09T14:08:49.000Z",
"lastUpdatedAt": "2023-11-07T05:31:56Z",
"lastEnrichedAt": "2025-11-10T18:03:16.000Z",
"lastActiveAt": "2025-11-10T12:00:00.000Z",
"isFresh": true,
"isStale": true,
"confidence": 0.5,
"platformData": {
"isVerifiedBlue": true,
"isVerifiedGold": true,
"isVerifiedGray": true,
"professionalCategory": "986",
"urlEntities": [
{
"url": "<string>",
"expandedUrl": "<string>",
"displayUrl": "<string>",
"indices": [
123,
123
]
}
],
"bannerUrl": "https://pbs.twimg.com/profile_banners/1566123362161725440/1753273968",
"tweetsCount": 123,
"favoritesCount": 123,
"rawData": {}
}
},
"context": {
"tags": [
"<string>"
],
"statusId": "df6jbw4h36...",
"valuation": 599,
"notes": "This prospect is a potential customer.",
"threads": [
{
"id": "<string>",
"accountLinkId": "<string>",
"lastMessageTimestamp": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
]
},
"data": {
"custom_q5cktl47a6pqa74eu06fz89v": "Acme Corp",
"custom_m8r2xj93hd5bk0atcw7oe4fp": "CEO"
},
"accountLinkId": "<string>",
"threadId": "<string>"
}
],
"nextCursor": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the campaign.
Pattern:
^[0-9a-z]+$Query Parameters
Pagination cursor. Omit to start from the beginning.
Maximum number of leads to return per page. Defaults to 50, maximum 100.
Required range:
1 <= x <= 100Example:
50
Filter leads by their campaign stage.
Available options:
pending, ready, ongoing, replied, unresponsive, failed, canceled Free-text search query to filter leads by name, username, or bio.
Example:
"john"
Structured filter query for advanced filtering.
Show child attributes
Show child attributes
Sort order for results. Defaults to followers descending.
Show child attributes
Show child attributes
Was this page helpful?
⌘I