Skip to main content
GET
/
v1
/
people
/
search
Search contacts
curl --request GET \
  --url https://api.clientcommander.com/v1/people/search \
  --header 'Authorization: Bearer <token>'
{
  "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"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key for authentication using Bearer token scheme.

How to get your API key:

  1. Log into Client Commander
  2. Go to Admin > API Keys
  3. Click Create API Key
  4. Copy the key and use it in the Authorization header:
Authorization: Bearer ccmd_live_your_key_here

Query Parameters

id
string

Contact ID (exact match)

Example:

"jd79abc123def"

email
string<email>

Email address (exact match)

Example:

"john@example.com"

phone
string

Phone number (normalized match)

Example:

"+15551234567"

name
string

Full name (fuzzy match)

Minimum string length: 2
Example:

"John Doe"

Response

Search results (max 10 contacts)

meta
object
required
data
object[]
Maximum array length: 10