Identify
Returns the user behind the token, their enabled modules, the installation's constants (stage keys and labels, task priorities, loss reasons…), the product list and the licence state. Call it first when your integration starts: stage keys differ per installation, so read constants.stages and constants.stage_labels from here. Since v42 it also returns api (42; 43 from v43), caps (what the user may use — unlicensed modules are false), plan (for admins: modules not in the plan and one upgrade_url), team (active users, for mentions), badges and ai_models. v43 adds caps.qe2, caps.objects and the custom objects shown on mobile (objects). v48: api 48 and caps.note_labels (note labels). v49: api 49, caps.note_archive (note archive), constants.stage_gates (stage gates: on, seq, win_from, per-stage exit conditions {k, m: block|warn, label}, win). v50: api 50, caps.chats (Ask chats), caps.mail_categories and constants.mail_categories (k, label, color). v52c: api 52, caps.pipeline2 (pipeline summary, waterfall, records), caps.boards (dashboards — reports module), caps.opp_pano (opportunity board), constants.nav_main (default menu order). v53: api 53, caps.panos (module boards), caps.lead_lookup (company lookup in fair lead entry, convert to CRM, bulk actions). v54: api 54, caps.erp (an ERP connection exists), caps.erp_push (send orders to the ERP), caps.erp_stock (live stock). v54b: caps.order_po (the customer PO number on an order can be edited). v58: caps.push (phone notifications available — /push/*). v59: caps.share (share from phone — /share), caps.card_scan (business card reading — /cards/*), caps.callerid (caller ID — /callerid) — Advanced / Enterprise plans; mobile_pro (pro, callerid_admin_off, upgrade_url, phone_cc). v60: user.photo (photo path or null), user.color (team colour), user.phone, user.ui (palette, theme — empty = not chosen, light, dark, on_light, on_dark); palettes (colour palettes, the first is the company colour), product_groups (product groups, the first is All products), pot (on, title — the potential section on the company card), products[].group, team[].photo and team[].color; users[] rows also carry photo and color. v61: caps.card (digital business cards on in the workspace — /card; every plan). v62: caps.notif2 (notifications with type, title, description and person — /notifications?v=2); badges.notifications no longer counts system notifications. v65: caps.support (the installation is connected to the Solk panel — Solk support), support (on, email, unread — unread replies from Solk). v66: caps.visits2 (visit list / detail, team's day), caps.geo (visit location on), geo66 (mode — off · optional · required, radius, types, reasons, checkin — the open "I'm here" check-in). v67: caps.tel (call through the phone system — the user's extension is mapped, /tel/dial), caps.tel_calls (a phone system is connected — /tel/calls), caps.sms (SMS can be sent), tel67 (c2c, provider, ext — extension, plan), sms67 (on, provider, footer — commercial message line set, kinds (k, label, desc, off), templates — template count) — Advanced / Enterprise plans. v80: caps.agents (agent reports). v92: caps.activity (activity feed, stamp and notes on records), caps.wa (WhatsApp Business connected and the companies module on). v94: caps.call_list (add to call list — a call centre is connected and the user has the Phone system & SMS module), dl94 (on, links — id, name, appointments).
Authorization
Authorizationheaderrequiredcrm.readcurl https://ornek.solk.app/api/v1/me \
-H "Authorization: Bearer $SOLK_API_KEY"const res = await fetch("https://ornek.solk.app/api/v1/me", {
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/me",
headers={"Authorization": f"Bearer {os.environ['SOLK_API_KEY']}"},
)
print(r.json()){
"ai": false,
"ai_models": [],
"api": 54,
"app": {
"accent": "#0f3a44",
"accent_dark": "#0b2b33",
"company": "Örnek Kimya",
"currencies": [
"EUR"
],
"currency_base": "EUR",
"currency_symbol": "€",
"logo": "",
"name": "Solk CRM",
"opp_lifetime_days": 180,
"site_url": "https://ornek.solk.app",
"stage_sla": {
"Expect to Close": 15,
"Negotiation": 30,
"Present Solution": 60,
"Qualify": 30,
"Viable": 60
},
"ticket_sla_hours": {
"Acil": 4,
"Düşük": 168,
"Normal": 72,
"Yüksek": 24
},
"unit_default": "kg",
"units": [
"kg"
],
"version": "v62"
},
"badges": {
"approvals": 3,
"notifications": 0
},
"caps": {
"ai": false,
"approval_forms": true,
"approvals": true,
"ask": true,
"boards": true,
"calendar": true,
"callerid": true,
"calls": true,
"card": true,
"card_scan": true,
"chats": true,
"comments": true,
"contracts": true,
"customers": true,
"demos": true,
"email": true,
"erp": false,
"erp_push": false,
"erp_stock": false,
"fairs": true,
"forecast": true,
"forms": true,
"lead_lookup": true,
"mail_categories": true,
"mailauto": true,
"note_archive": true,
"note_labels": true,
"notes": true,
"notif2": true,
"objects": true,
"opp_pano": true,
"opportunities": true,
"order_po": true,
"panos": true,
"performance": true,
"pipeline": true,
"pipeline2": true,
"push": false,
"qe2": true,
"rcpt": true,
"reports": true,
"share": true,
"tasks": true,
"tickets": true,
"visits": true
},
"constants": {
"action_soon_days": 7,
"barriers": [
"Fiyat"
],
"customer_statuses": [
"AC"
],
"demo_results": [
"Başarılı"
],
"demo_statuses": [
"Henüz Deneme Aşamasına Gelmedik"
],
"forecast_cats": [
"Pipeline"
],
"lead_interest": [
"Sıcak"
],
"lead_next_actions": [
"Teklif gönder"
],
"lead_statuses": [
"Yeni"
],
"lead_timings": [
"Hemen"
],
"lead_visitor_types": [
"Potansiyel müşteri"
],
"loss_reasons": [
"Fiyat"
],
"mail_categories": [
{
"color": "#2a78d6",
"k": "musteri",
"label": "Müşteri yazışması"
}
],
"makro_stages": [
"Takip"
],
"nav_main": [
"today"
],
"next_actions": [
"Numune Gönder"
],
"open_stages": [
"Qualify"
],
"opp_line_label": "",
"opp_status_labels": false,
"opp_types": [
"Yeni Müşteri"
],
"order_kinds": [
"İlk Sipariş"
],
"stage_colors": {
"Cancel": "#62767a",
"Expect to Close": "#2d9d78",
"Lost": "#c23934",
"Negotiation": "#e0a228",
"Present Solution": "#6b5bd6",
"Qualify": "#8a9ba0",
"Viable": "#2a78d6",
"Win": "#24733f"
},
"stage_gate": {
"Expect to Close": "kapanış bekleniyor",
"Negotiation": "fiyat / vade pazarlığı",
"Present Solution": "aktif deneme, sonucu net",
"Qualify": "BANT 4/4",
"Viable": "f2f ziyaret + doğru ürün"
},
"stage_gates": {
"custom": false,
"exit": {
"Negotiation": [
{
"k": "price",
"label": "Teklif fiyatı",
"m": "block"
}
],
"Present Solution": [
{
"k": "demo_ok",
"label": "Deneme sonucu olumlu",
"m": "block"
}
],
"Qualify": [
{
"k": "bant",
"label": "BANT 4/4",
"m": "block"
}
],
"Viable": [
{
"k": "f2f",
"label": "Yüz yüze görüşme",
"m": "block"
}
]
},
"on": true,
"seq": true,
"win": [],
"win_from": [
"Negotiation"
]
},
"stage_labels": {
"Cancel": "Cancel",
"Expect to Close": "Expect to Close",
"Lost": "Lost",
"Negotiation": "Negotiation",
"Present Solution": "Present Solution",
"Qualify": "Qualify",
"Viable": "Viable",
"Win": "Win"
},
"stage_rules": true,
"stage_sla": {
"Expect to Close": 15,
"Negotiation": 30,
"Present Solution": 60,
"Qualify": 30,
"Viable": 60
},
"stages": [
"Qualify"
],
"task_priorities": [
"Düşük"
],
"task_statuses": [
"Açık"
],
"visit_period": {
"AC": 90,
"Prospect": 180
},
"visit_topics": [
"Yeni Ürünler"
],
"visit_types": [
"F2F"
]
},
"features": [
"notes",
"comments"
],
"license": {
"blocked": false,
"customer": "Örnek Kimya",
"days_left": null,
"end": null,
"label": "Deneme modu",
"modules": [
"calendar"
],
"no": null,
"state": "trial"
},
"mailbox": {
"connected": true,
"email": "deniz@ornekkimya.com.tr",
"error": "",
"signature": false,
"status": "ok"
},
"mobile_pro": {
"callerid_admin_off": false,
"phone_cc": "90",
"pro": true,
"upgrade_url": null
},
"objects": [
{
"icon": "gear-wide-connected",
"key": "uretim_hatti",
"label": "Üretim hattı",
"plural": "Üretim hatları",
"quick_entry": false
},
{
"icon": "gear-wide-connected",
"key": "uretim_hatti_2",
"label": "Üretim hattı",
"plural": "Üretim hatları",
"quick_entry": true
}
],
"ok": true,
"palettes": [
{
"dark": "#6C6E71",
"key": "graphite",
"label": "Grafit",
"light": "#1F2023",
"on_dark": "#FFFFFF",
"on_light": "#FFFFFF"
},
{
"dark": "#3C7682",
"key": "petrol",
"label": "Petrol",
"light": "#1E5A66",
"on_dark": "#FFFFFF",
"on_light": "#FFFFFF"
}
],
"plan": {
"missing": [],
"upgrade_url": null
},
"pot": {
"on": true,
"title": "Potansiyel ve pazar payı"
},
"product_groups": [
{
"label": "Tüm ürünler",
"n": null,
"name": "",
"unit": "kg",
"unit_label": "kg"
}
],
"products": [
{
"code": "HS30",
"group": "",
"id": 5,
"list_price": 6.4,
"name": "HS 30 Isıl Yapışma Laki"
},
{
"code": "SB450",
"group": "",
"id": 3,
"list_price": 3.8,
"name": "PU-SB 450 Solvent Bazlı Yapıştırıcı"
}
],
"team": [
{
"color": "#b95ccd",
"full_name": "Ayşe Demir",
"id": 2,
"photo": null
},
{
"color": "#5867e8",
"full_name": "Deniz Aksoy",
"id": 1,
"photo": null
}
],
"user": {
"color": "#5867e8",
"email": "deniz@ornekkimya.com.tr",
"full_name": "Deniz Aksoy",
"id": 1,
"modules": [
"calendar"
],
"phone": "",
"photo": null,
"role": "admin",
"role_label": "Yönetici",
"ui": {
"dark": "#6C6E71",
"light": "#1F2023",
"on_dark": "#FFFFFF",
"on_light": "#FFFFFF",
"palette": "graphite",
"theme": ""
},
"username": "admin"
},
"users": [
{
"color": "#b95ccd",
"full_name": "Ayşe Demir",
"id": 2,
"photo": null,
"role": "sales",
"role_label": "Satış",
"username": "ayse"
},
{
"color": "#5867e8",
"full_name": "Deniz Aksoy",
"id": 1,
"photo": null,
"role": "admin",
"role_label": "Yönetici",
"username": "admin"
}
],
"weak_password": true
}Example responses were captured from a v98 installation running sample data; lists are shortened to two items.