REST API

Sayfalama ve süzme

Liste uçlarında sayfa, kapsam, süzgeç ve sıralama parametreleri.

Sayfalama

Firma ve fırsat listeleri sayfalanır:

Parametre	Varsayılan	Açıklama
`page`	`1`	Sayfa numarası.
`per`	`40`	Sayfa başına satır (10–100).

Yanıt rows, total (süzülmüş toplam), page ve pages taşır:

{ "ok": true, "rows": [ … ], "total": 21, "page": 1, "pages": 3 }

Tüm kayıtları almak için page değerini pages'e kadar artırın:

def tum_firmalar(oturum):
    sayfa = 1
    while True:
        j = oturum.get("https://ornek.solk.app/api/v1/customers",
                       params={"scope": "all", "per": 100, "page": sayfa}).json()
        yield from j["rows"]
        if sayfa >= j["pages"]:
            break
        sayfa += 1

Kişi, aksiyon, fuar leadi ve e-posta yazışması listeleri sayfalanmaz; sırasıyla en çok 300, tüm açık aksiyonlar, 300 ve 100 kayıt döner. Daha dar sonuç için süzgeç kullanın.

Kapsam

Çoğu liste scope alır:

Değer	Sonuç
`mine`	Sorumlusu benim olan kayıtlar (satış rolünün varsayılanı)
`all`	Görme yetkim olan tüm kayıtlar (yönetici rolünün varsayılanı)
`<kullanıcı kimliği>`	O kullanıcının kayıtları

Kapsam görünürlüğü genişletmez: takım görünürlüğü açık bir kurulumda scope=all yalnız kendi takımınızın kayıtlarını getirir. Bkz. Kullanıcılar ve roller.

Süzgeçler ve sıralama

Uç	Süzgeçler	Sıralama (`sort`)
Firmalar	`q`, `status`, `city`, `visit`, `risk`, `active`	`name`, `visit`, `priority`
Fırsatlar	`q`, `stage` (`open`, `closed`, `account`, aşama anahtarı)	`update`, `health`, `value`, `sla`
Kişiler	`q`, `former`	ad
Aksiyonlar	`state` (`today`, `overdue`, `soon`, `open`, `week`), `customer_id`	termin
Takvim	`from`, `to`, `done`	başlangıç
Fuar leadleri	`q`, `interest`, `owner`	yeniden eskiye
Yazışmalar	`kind` + `id` ya da `filter`, `q`	son iletiye göre

q metin araması büyük-küçük harf duyarsızdır ve alanın herhangi bir yerinde geçeni bulur.

Değişenleri almak

Ayrı bir "değişenler" ucu yoktur. Eşitleme için:

Fırsatları sort=update ile alıp last_update alanına göre durun.
Yeni ve değişen kayıtlardan anında haberdar olmak için web kancalarını kullanın.