Advanced search in contacts by name, company, and tags

POST

/users/me/contacts/advanced-search

Multi-criteria filter with AND between groups and OR within a group: name is split on spaces and matched against firstName/lastName/companyName (and phoneNumber if it contains digits, with phone normalization), companies matches any in the array, tags matches any in the array. Supports custom sortBy and sortOrder. Tag filtering is case-sensitive — keep tag naming consistent across the app. Combining many filters narrows results aggressively.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/users/me/contacts/advanced-search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "string",
    "companies": [
        "string"
    ],
    "tags": [
        "string"
    ],
    "limit": 20,
    "offset": 0,
    "sortBy": "createdAt",
    "sortOrder": "desc"
}'

Response Example

{
    "contacts": [
        {
            "firstName": "string",
            "lastName": "string",
            "phoneNumber": "string",
            "email": "string",
            "address": "string",
            "notes": "string",
            "companyName": "string",
            "tags": [
                "string"
            ],
            "avatar": "string",
            "isFavorite": true,
            "source": "MOBILE",
            "lifecycleStage": "lead",
            "doNotCall": true,
            "doNotSms": true,
            "id": "string",
            "stats": {
                "totalIncomingCalls": 0,
                "totalOutboundCalls": 0,
                "totalSmsMessages": 0,
                "lastCallDate": "string",
                "upcomingAppointments": 0
            },
            "latestNote": {
                "content": "string",
                "createdAt": "string"
            },
            "suggestedLifecycleStage": "string"
        }
    ],
    "pagination": {
        "total": 0,
        "limit": 0,
        "offset": 0
    },
    "aggregations": {
        "uniqueCompanies": 0,
        "companies": [
            "string"
        ]
    }
}

Modified at 2026-07-23 18:02:16

Get tag statistics for autocomplete

List notes for a customer (newest first)