Skip to main content
GET
Search contacts

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:

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