Ana içeriğe atla
GET

Ne yapar?

Firma kapsamındaki kayıtları listeler. Kimlik filtreleri sayım ve sonuç için aynı kapsamda değerlendirilir. Başlık araması düz metindir. Proje/görevde page=1,limit=50; üst sınır 250. Etiket/durum listeleri sayfalamasızdır. Kayıtlar oluşturulma zamanı azalan; durumlar order artan sıralıdır.

Ön koşullar ve izin

Etkin API anahtarı ve muhasip:todo:read izni gerekir. İlişkili kayıtlar aynı firmaya ait olmalıdır. Erişim ayarları için kimlik ve izinler rehberini inceleyin. İstek ve cevap şemalarını indirin.

İstek örnekleri

Örnekler temsilîdir. Kimlikleri, belge tarihlerini ve iş verisini kendi yetkili kayıtlarınızla değiştirin. Node.js örnekleri Node.js 20 veya üzeri içindir; PHP örnekleri cURL uzantısını kullanır. Hiçbiri otomatik tekrar yapmaz.

Cevabı değerlendirin

Önce HTTP durumunu, ardından bu kaynağın status ve sonuç alanlarını değerlendirin. Bütün uçlar aynı sonuç zarfını veya oluşturma için 201 kodunu kullanmaz. Temsilî başarılı cevap; gerçek hizmet çağrısından alınmamıştır:

Hata durumunda

Ağ kesintisi, zaman aşımı veya JSON olmayan cevap mali etkinin oluşmadığını kanıtlamaz. Ham istek/cevapları genel loglara yazmayın. Hata yönetimi

Sonraki adım

Dönen kimlik ve durumları saklayın; iş akışınızın ilgili detay veya yazma adımında kullanın. Kaynak akışı · İşlem takibi · Kapsam ve sınırlamalar

Yetkilendirmeler

Authorization
string
header
gerekli

Kullanıcı adı apiUserId, parola secretKey. Aktif ve süresi geçmemiş API kullanıcısı ve uygun firma gerekir.

Sorgu Parametreleri

page
integer
varsayılan:1

1 tabanlı sayfa.

Gerekli aralık: x >= 1
Örnek:

1

limit
integer
varsayılan:50

Pozitif sayfa boyutu; en fazla 250.

Gerekli aralık: 1 <= x <= 250
Örnek:

50

q
string

Başlıkta büyük/küçük harf duyarsız düz metin araması; en fazla 500 karakter.

Maximum string length: 500
Örnek:

"Ödeme"

isArchived
boolean

Verilmezse aktif/arşiv birlikte okunur.

usersId
string

Firma kapsamındaki kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$
labelsId
string

Firma kapsamındaki kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$
dueStart
string

dueDate alt sınırı; dahil.

dueEnd
string

dueDate üst sınırı; dahil.

projectId
string

Firma kapsamındaki kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$
statusId
string

Firma kapsamındaki kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$
contactsId
string

Firma kapsamındaki kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$
salesId
string

Firma kapsamındaki kayıt kimliği.

Pattern: ^[a-fA-F0-9]{24}$
compStart
string

Tamamlanma tarihi alt sınırı; dahil.

compEnd
string

Tamamlanma tarihi üst sınırı; dahil.

Yanıt

İşlem cevabı. Örnek değerler temsilîdir.

status
boolean
gerekli
Örnek:

true

result
object[]
total
integer