Skip to main content
GET
/
v1
/
people
List contacts
curl --request GET \
  --url https://api.clientcommander.com/v1/people \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "jd79abc123def",
      "firstName": "John",
      "lastName": "Doe",
      "fullName": "John Doe",
      "emails": [
        {
          "value": "john@example.com",
          "type": "home",
          "isPrimary": true
        }
      ],
      "phones": [
        {
          "value": "+15551234567",
          "type": "mobile",
          "isPrimary": true,
          "status": "Valid",
          "isBad": false
        }
      ],
      "assignedAgentId": "agent123",
      "assignedAgentName": "Jane Smith",
      "stageId": "stage456",
      "stageName": "Lead",
      "source": "Website",
      "tags": "VIP, Hot Lead",
      "price": 450000,
      "createdAt": "2023-11-15T10:00:00Z"
    }
  ],
  "meta": {
    "requestId": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2023-11-15T10:30:00Z",
    "version": "1.0.0",
    "count": 1,
    "hasMore": true,
    "nextCursor": "eyJpZCI6ImpkNzlhYmMxMjNkZWYifQ=="
  }
}

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

limit
integer
default:10

Maximum number of items to return

Required range: 1 <= x <= 100
cursor
string

Opaque pagination cursor for next page

Response

Successfully retrieved contacts

meta
object
required
data
object[]