Workspace

Search

Searches companies (name, city), people (name, phone, e-mail), opportunities and fair leads; up to 10–15 results per type. Passing a 15-character record ID (001…, 006…) resolves it in the record field.

GET/api/v1/search

Authorization

Authorizationheaderrequired

Bearer token: API key (sk_…), OAuth access token (mcp_…) or mobile session (xk_…).

Scope: crm.read

Query parameters

qstringrequired

Search text (at least 2 characters).

Request

curl "https://ornek.solk.app/api/v1/search?q=Alize" \
  -H "Authorization: Bearer $SOLK_API_KEY"

const res = await fetch("https://ornek.solk.app/api/v1/search?q=Alize", {
  headers: {
    Authorization: `Bearer ${process.env.SOLK_API_KEY}`,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://ornek.solk.app/api/v1/search",
    headers={"Authorization": f"Bearer {os.environ['SOLK_API_KEY']}"},
    params={"q": "Alize"},
)
print(r.json())

Response

{
  "contacts": [
    {
      "customer": "Alize Paketleme San. ve Tic. A.Ş.",
      "customer_id": 1,
      "department": "Satın Alma",
      "email": "selin.dogan@alizepaketleme.example",
      "id": 1,
      "is_former": false,
      "is_main": true,
      "name": "Selin Doğan",
      "note": "",
      "phone": "0 (212) 000 55 24",
      "rid": "003MaZR2tfJCp1h",
      "title": "Satın Alma Müdürü",
      "wa": "902120005524"
    }
  ],
  "customers": [
    {
      "active": true,
      "at_risk": false,
      "city": "İstanbul",
      "currency": "EUR",
      "currency_default": "",
      "id": 1,
      "initials": "AP",
      "last_visit": "2026-09-30",
      "main_contact": {
        "email": "selin.dogan@alizepaketleme.example",
        "name": "Selin Doğan",
        "phone": "0 (212) 000 55 24",
        "wa": "902120005524"
      },
      "name": "Alize Paketleme San. ve Tic. A.Ş.",
      "next_visit_due": "2026-12-29",
      "open_opps": 1,
      "owner": {
        "full_name": "Deniz Aksoy",
        "id": 1,
        "role": "admin",
        "role_label": "Yönetici",
        "username": "admin"
      },
      "pending_state": "overdue",
      "period": 90,
      "phone": "0 (212) 000 15 65",
      "potential_kg": 8000.0,
      "rid": "001RBoHIo80N8nR",
      "sector": "Gıda ambalajı",
      "status": "AC",
      "status_label": "Aktif Müşteri",
      "unit": "kg",
      "visit_overdue_days": -88,
      "visit_state": "ok"
    }
  ],
  "leads": [
    {
      "can_edit": true,
      "city": "Konya",
      "company": "Alize Ambalaj A.Ş.",
      "contact_name": "Barış Kaya",
      "created_at": "2026-08-25T15:10:00",
      "customer_id": null,
      "email": "baris@alizeambalajas.example",
      "fair": "Ambalaj Fuarı 2026 (örnek)",
      "fair_id": 1,
      "id": 5,
      "initials": "AA",
      "interest": "Sıcak",
      "line": "",
      "next_action": "Teklif gönder",
      "next_date": "2026-10-03",
      "note": "Stantta görüşüldü.",
      "opp_id": null,
      "opp_type": "Yeni Müşteri",
      "owner": {
        "full_name": "Deniz Aksoy",
        "id": 1,
        "role": "admin",
        "role_label": "Yönetici",
        "username": "admin"
      },
      "phone": "0 (332) 000 44 97",
      "potential_kg": 4000.0,
      "products": "5",
      "products_text": "",
      "project_note": "",
      "rid": "00QiUPO55IJhtmL",
      "sector": "Etiket",
      "status": "Yeni",
      "status_eff": "Yeni",
      "supplier": "Mevcut tedarikçi (Asya)",
      "task_id": null,
      "timing": "3 ay içinde",
      "title": "Genel Müdür",
      "unit": "kg",
      "visitor_type": "Potansiyel müşteri",
      "wa": "903320004497",
      "website": ""
    }
  ],
  "ok": true,
  "opps": [
    {
      "bant": 0,
      "base_currency": "EUR",
      "close_date": "2027-03-31",
      "cur_sym": "€",
      "currency": "EUR",
      "customer": "Alize Paketleme San. ve Tic. A.Ş.",
      "customer_city": "İstanbul",
      "customer_id": 1,
      "days_in_stage": 0,
      "detail_status": "",
      "fc": "Omitted",
      "health": null,
      "health_color": null,
      "health_manual": false,
      "health_note": "",
      "id": 44,
      "initials": "AP",
      "is_account": true,
      "is_open": false,
      "last_update": "2026-10-02",
      "lifetime_left": 180,
      "line": "",
      "name": "Müşteri Takibi",
      "next_step": null,
      "offer_price": null,
      "owner": {
        "full_name": "Deniz Aksoy",
        "id": 1,
        "role": "admin",
        "role_label": "Yönetici",
        "username": "admin"
      },
      "payment_days": null,
      "potential_kg": null,
      "prob": 0.0,
      "probability": null,
      "product": "",
      "product_id": null,
      "pu": "€/kg",
      "rid": "006w4ETEfW9soDW",
      "sla_days": null,
      "sla_left": null,
      "source": "",
      "stage": "Account",
      "stage_label": "Müşteri Takibi",
      "start_date": "2026-10-02",
      "trend": "",
      "trend_label": "Otomatik",
      "type": "Müşteri Takibi",
      "unit": "kg",
      "unit_code": "kg",
      "value": 0,
      "value_base": 0,
      "value_short": "0"
    },
    {
      "bant": 4,
      "base_currency": "EUR",
      "close_date": "2026-10-01",
      "cur_sym": "€",
      "currency": "EUR",
      "customer": "Alize Paketleme San. ve Tic. A.Ş.",
      "customer_city": "İstanbul",
      "customer_id": 1,
      "days_in_stage": 1,
      "detail_status": "",
      "fc": "Closed",
      "health": null,
      "health_color": null,
      "health_manual": false,
      "health_note": "",
      "id": 1,
      "initials": "AP",
      "is_account": false,
      "is_open": false,
      "last_update": "2026-10-01",
      "lifetime_left": 115,
      "line": "",
      "name": "Yeni Müşteri · 2026",
      "next_step": null,
      "offer_price": 3.92,
      "owner": {
        "full_name": "Deniz Aksoy",
        "id": 1,
        "role": "admin",
        "role_label": "Yönetici",
        "username": "admin"
      },
      "payment_days": 120,
      "potential_kg": 1500.0,
      "prob": 1.0,
      "probability": null,
      "product": "PU-SL 200 Solventsiz Laminasyon Yapıştırıcısı",
      "product_id": 1,
      "pu": "€/kg",
      "rid": "006kmnffbRT8muo",
      "sla_days": null,
      "sla_left": null,
      "source": "Bayi / distribütör",
      "stage": "Win",
      "stage_label": "Win",
      "start_date": "2026-07-29",
      "trend": "",
      "trend_label": "Otomatik",
      "type": "Yeni Müşteri",
      "unit": "kg",
      "unit_code": "kg",
      "value": 70560.0,
      "value_base": 70560.0,
      "value_short": "71K"
    }
  ],
  "record": null
}

Example responses were captured from a v22 installation running sample data; lists are shortened to two items.