Search contacts
curl --request GET \
--url https://api.clientcommander.com/v1/people/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.clientcommander.com/v1/people/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clientcommander.com/v1/people/search', 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.clientcommander.com/v1/people/search",
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.clientcommander.com/v1/people/search"
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.clientcommander.com/v1/people/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clientcommander.com/v1/people/search")
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{
"meta": {
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"version": "1.0.0"
},
"data": [
{
"id": "jd79abc123def",
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"createdAt": "2023-11-15T10:00:00Z",
"emails": [
{
"value": "john@example.com",
"type": "work",
"isPrimary": false
}
],
"phones": [
{
"value": "+15551234567",
"type": "mobile",
"status": "Valid",
"isPrimary": true,
"isBad": true
}
],
"assignedAgentId": "<string>",
"assignedAgentName": "Jane Smith",
"assignedAgentEmail": "jsmith@example.com",
"stageId": "<string>",
"stageName": "Lead",
"source": "Website Signup",
"tags": "VIP, Hot Lead, Referral",
"price": 450000,
"timeframe": "3-6 months",
"background": "<string>",
"relationship": false,
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "BAD_REQUEST",
"message": "Missing required parameter",
"details": [
{
"field": "personId",
"message": "Required field is missing",
"code": "REQUIRED_FIELD"
}
],
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2023-11-15T10:00:00Z"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2023-11-15T10:00:00Z"
}
}People
Search Contacts
Search for contacts by ID, email, phone, or name.
Search Priority: ID → Email → Phone → Name
Fuzzy Matching: Name searches support partial matches (case-insensitive).
GET
/
v1
/
people
/
search
Search contacts
curl --request GET \
--url https://api.clientcommander.com/v1/people/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.clientcommander.com/v1/people/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clientcommander.com/v1/people/search', 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.clientcommander.com/v1/people/search",
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.clientcommander.com/v1/people/search"
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.clientcommander.com/v1/people/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clientcommander.com/v1/people/search")
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{
"meta": {
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"timestamp": "2023-11-07T05:31:56Z",
"version": "1.0.0"
},
"data": [
{
"id": "jd79abc123def",
"firstName": "John",
"lastName": "Doe",
"fullName": "John Doe",
"createdAt": "2023-11-15T10:00:00Z",
"emails": [
{
"value": "john@example.com",
"type": "work",
"isPrimary": false
}
],
"phones": [
{
"value": "+15551234567",
"type": "mobile",
"status": "Valid",
"isPrimary": true,
"isBad": true
}
],
"assignedAgentId": "<string>",
"assignedAgentName": "Jane Smith",
"assignedAgentEmail": "jsmith@example.com",
"stageId": "<string>",
"stageName": "Lead",
"source": "Website Signup",
"tags": "VIP, Hot Lead, Referral",
"price": 450000,
"timeframe": "3-6 months",
"background": "<string>",
"relationship": false,
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "BAD_REQUEST",
"message": "Missing required parameter",
"details": [
{
"field": "personId",
"message": "Required field is missing",
"code": "REQUIRED_FIELD"
}
],
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2023-11-15T10:00:00Z"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"requestId": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2023-11-15T10:00:00Z"
}
}Authorizations
API key for authentication using Bearer token scheme.
How to get your API key:
- Log into Client Commander
- Go to Admin > API Keys
- Click Create API Key
- Copy the key and use it in the Authorization header:
Authorization: Bearer ccmd_live_your_key_here
Query Parameters
Contact ID (exact match)
Example:
"jd79abc123def"
Email address (exact match)
Example:
"john@example.com"
Phone number (normalized match)
Example:
"+15551234567"
Full name (fuzzy match)
Minimum string length:
2Example:
"John Doe"
⌘I

