curl --request POST \
--url https://your-instance.example.com/api/contacts/status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "New Lead",
"pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1",
"page": 1,
"size": 50,
"ownerFilter": "all"
}
'import requests
url = "https://your-instance.example.com/api/contacts/status"
payload = {
"status": "New Lead",
"pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1",
"page": 1,
"size": 50,
"ownerFilter": "all"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'New Lead',
pipelineId: '64f0a1b2c3d4e5f6a7b8c9d1',
page: 1,
size: 50,
ownerFilter: 'all'
})
};
fetch('https://your-instance.example.com/api/contacts/status', 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://your-instance.example.com/api/contacts/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'New Lead',
'pipelineId' => '64f0a1b2c3d4e5f6a7b8c9d1',
'page' => 1,
'size' => 50,
'ownerFilter' => 'all'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/contacts/status"
payload := strings.NewReader("{\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\",\n \"page\": 1,\n \"size\": 50,\n \"ownerFilter\": \"all\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/contacts/status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\",\n \"page\": 1,\n \"size\": 50,\n \"ownerFilter\": \"all\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contacts/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\",\n \"page\": 1,\n \"size\": 50,\n \"ownerFilter\": \"all\"\n}"
response = http.request(request)
puts response.read_body{
"data": [],
"total": 0,
"status": "New Lead",
"pipelineStage": "64f0a1b2c3d4e5f6a7b8c9d2"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}Get contacts for one status
Returns the paginated contacts in a single pipeline status / stage. Used to expand a Kanban column or status drawer beyond its initial page. Honors search, ownership, and the unified-filter-drawer advanced filters.
curl --request POST \
--url https://your-instance.example.com/api/contacts/status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "New Lead",
"pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1",
"page": 1,
"size": 50,
"ownerFilter": "all"
}
'import requests
url = "https://your-instance.example.com/api/contacts/status"
payload = {
"status": "New Lead",
"pipelineId": "64f0a1b2c3d4e5f6a7b8c9d1",
"page": 1,
"size": 50,
"ownerFilter": "all"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'New Lead',
pipelineId: '64f0a1b2c3d4e5f6a7b8c9d1',
page: 1,
size: 50,
ownerFilter: 'all'
})
};
fetch('https://your-instance.example.com/api/contacts/status', 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://your-instance.example.com/api/contacts/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'New Lead',
'pipelineId' => '64f0a1b2c3d4e5f6a7b8c9d1',
'page' => 1,
'size' => 50,
'ownerFilter' => 'all'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/api/contacts/status"
payload := strings.NewReader("{\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\",\n \"page\": 1,\n \"size\": 50,\n \"ownerFilter\": \"all\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://your-instance.example.com/api/contacts/status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\",\n \"page\": 1,\n \"size\": 50,\n \"ownerFilter\": \"all\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-instance.example.com/api/contacts/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"New Lead\",\n \"pipelineId\": \"64f0a1b2c3d4e5f6a7b8c9d1\",\n \"page\": 1,\n \"size\": 50,\n \"ownerFilter\": \"all\"\n}"
response = http.request(request)
puts response.read_body{
"data": [],
"total": 0,
"status": "New Lead",
"pipelineStage": "64f0a1b2c3d4e5f6a7b8c9d2"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}{
"error": "Attachment not found",
"message": "Attachment not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Stage to query, identified by stage name or stage _id.
Pipeline _id to query; falls back to the org's active Contact pipeline when omitted.
1-based page number for the requested stage.
Page size (default 50).
Case-insensitive substring match across name and phone number.
Restrict to contacts whose isUpdated flag is set.
Quick-tab owner scope: my, all, team, unassigned, or a specific user _id.
Restrict to contacts created via bulk import.
Restrict to contacts with at least one webchat conversation in a pending/unresolved state.