الانتقال إلى المحتوى الرئيسي
GET
curl

نظرة عامة

يُرجع قائمة مقسَّمة على صفحات من كيانات الشركات للتطبيق المصادَق عليه.

متى تستخدمه

  • مزامنة جدول الشركات مع أداة ذكاء أعمال خارجية أو مستودع بيانات.
  • طوابير المحللين: صفِّ النتائج بالمعامل status=FLAGGED لتغذية صندوق وارد المراجعة.
  • بحث بواسطة display_name أو legal_name أو registration_number أو vendor_data.

الفلاتر والترقيم الصفحي

ملاحظات

  • قد تكون قيمة vendor_data هي null إذا لم تُرسل الجلسة أو المعاملة الأصلية قيمة لها.
  • الترقيم الصفحي بالمؤشر: احفظ المؤشر next بين الاستدعاءات.
  • راجع نموذج بيانات الشركات للاطلاع على كل حقل.

الأذونات

يجب أن يمنح الدور الصلاحية list:businesses.

ذات صلة

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

معلمات الاستعلام

limit
integer
افتراضي:50

حجم الصفحة. القيمة الافتراضية 50 عند إغفاله. لا يوجد حد أقصى مفروض، ولكن حافظ على صغر حجم الصفحات لتقليل زمن الاستجابة.

النطاق المطلوب: 1 <= x <= 1000000
offset
integer
افتراضي:0

إزاحة تستند إلى الصفر للسجل الأول المراد إرجاعه. يُفضل اتباع رابط next من الصفحة السابقة بدلاً من حساب ذلك يدوياً.

النطاق المطلوب: 0 <= x <= 1000000

الاستجابة

قائمة مقسمة إلى صفحات بالشركات مع الحالة وعدد الجلسات وتفصيل الميزات.

count
integer

عدد الصفوف المتطابقة — دقيق حتى 100، ويقتصر على 100 كحد أقصى بعد ذلك لتحسين الأداء. لا تستخدمه لاكتشاف الصفحة الأخيرة؛ اعتمد بدلاً من ذلك على كون next بقيمة null.

next
string | null

رابط URL مطلق للصفحة التالية، أو null في الصفحة الأخيرة.

previous
string | null

رابط URL مطلق للصفحة السابقة، أو null في الصفحة الأولى.

results
object[]
آخر تعديل في ٧ نوفمبر ٢٠٢٦