List contacts
curl --request GET \
--url https://api.talkpilot.io/v1/agents/{agentId}/contacts \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.talkpilot.io/v1/agents/{agentId}/contacts"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.talkpilot.io/v1/agents/{agentId}/contacts', 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.talkpilot.io/v1/agents/{agentId}/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.talkpilot.io/v1/agents/{agentId}/contacts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.talkpilot.io/v1/agents/{agentId}/contacts")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.talkpilot.io/v1/agents/{agentId}/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3f1c2a9e-5b7d-4e2f-9a1b-0c8d7e6f5a4b",
"agent_id": "550e8400-e29b-41d4-a716-446655440000",
"customer_name": "Herr Fey",
"salutation": "Herr",
"first_name": null,
"last_name": "Fey",
"name_parsed": "manual",
"name_source": "manual",
"phone_number": "+491711234567",
"mobile_number": "+491711234567",
"landline_number": "+492215550",
"email": "fey@example.com",
"address": "Musterstraße 1, 50667 Köln",
"company": "Fey GmbH",
"tags": [
"vip",
"stammkunde"
],
"note": "Bevorzugt Rückruf am Vormittag",
"customer_number": 4711,
"last_contact_date": "2026-09-01T09:30:00Z",
"created_at": "2026-08-01T10:00:00Z",
"updated_at": "2026-09-01T09:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
}
}Contacts
List contacts
Returns the agent’s contacts (customer database), newest first.
Filter by an exact phone number (matched against phone_number,
mobile_number and landline_number, like the voice agent does), by a
tag, or by a free-text search over name, company, e-mail and numbers.
GET
/
v1
/
agents
/
{agentId}
/
contacts
List contacts
curl --request GET \
--url https://api.talkpilot.io/v1/agents/{agentId}/contacts \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.talkpilot.io/v1/agents/{agentId}/contacts"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.talkpilot.io/v1/agents/{agentId}/contacts', 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.talkpilot.io/v1/agents/{agentId}/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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.talkpilot.io/v1/agents/{agentId}/contacts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
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.talkpilot.io/v1/agents/{agentId}/contacts")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.talkpilot.io/v1/agents/{agentId}/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3f1c2a9e-5b7d-4e2f-9a1b-0c8d7e6f5a4b",
"agent_id": "550e8400-e29b-41d4-a716-446655440000",
"customer_name": "Herr Fey",
"salutation": "Herr",
"first_name": null,
"last_name": "Fey",
"name_parsed": "manual",
"name_source": "manual",
"phone_number": "+491711234567",
"mobile_number": "+491711234567",
"landline_number": "+492215550",
"email": "fey@example.com",
"address": "Musterstraße 1, 50667 Köln",
"company": "Fey GmbH",
"tags": [
"vip",
"stammkunde"
],
"note": "Bevorzugt Rückruf am Vormittag",
"customer_number": 4711,
"last_contact_date": "2026-09-01T09:30:00Z",
"created_at": "2026-08-01T10:00:00Z",
"updated_at": "2026-09-01T09:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 1,
"pages": 1
}
}Authorizations
API key for external access. Format: tp_live_<32-hex-chars>.
Create keys in the TalkPilot Dashboard under Settings > API.
Path Parameters
Agent UUID
Query Parameters
Page number
Required range:
x >= 1Items per page
Required range:
1 <= x <= 100Exact E.164 number; matches any of the three number fields
Example:
"+491711234567"
Only contacts carrying this tag (exact, case-sensitive)
Example:
"vip"
Case-insensitive substring search over customer_name, company, email and the number fields