List people

People of active companies (max 300, by name). Former employees are excluded by default.

GET/api/v1/contacts

Authorization

Authorizationheaderrequired

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

Module: CustomersScope: crm.read

Query parameters

scopestringoptional

mine = records I own (default for sales users), all = every record I can see (default for admins), or a user id.

qstringoptional

Name, company, phone, e-mail or title contains.

formerstringoptional

1 = include former employees.

Request

curl "https://ornek.solk.app/api/v1/contacts?scope=all&q=a" \
  -H "Authorization: Bearer $SOLK_API_KEY"

const res = await fetch("https://ornek.solk.app/api/v1/contacts?scope=all&q=a", {
  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/contacts",
    headers={"Authorization": f"Bearer {os.environ['SOLK_API_KEY']}"},
    params={"scope": "all", "q": "a"},
)
print(r.json())

Response

{
  "ok": true,
  "rows": [
    {
      "customer": "Ortanca Matbaacılık Ltd. Şti.",
      "customer_id": 22,
      "department": "Satın Alma",
      "email": "ahmet.aydin@ortancamatbaacilik.example",
      "id": 42,
      "is_former": false,
      "is_main": true,
      "name": "Ahmet Aydın",
      "note": "",
      "phone": "0 (332) 000 81 52",
      "rid": "003qMFfAArgzPDF",
      "title": "Satın Alma Müdürü",
      "wa": "903320008152"
    },
    {
      "customer": "Kamelya Lamine Film Ltd. Şti.",
      "customer_id": 6,
      "department": "Teknik",
      "email": "ahmet.ozturk@kamelyalamine.example",
      "id": 11,
      "is_former": false,
      "is_main": true,
      "name": "Ahmet Öztürk",
      "note": "",
      "phone": "0 (232) 000 89 83",
      "rid": "003t3MMhbXHOFjR",
      "title": "Teknik Müdür",
      "wa": "902320008983"
    }
  ],
  "total": 58
}

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