मुख्य सामग्री पर जाएं
GET
curl

अवलोकन

यह प्रमाणित एप्लिकेशन के लिए उपयोगकर्ता इकाइयों की पेजिनेटेड सूची लौटाता है। इसका उपयोग अपने वेयरहाउस में उपयोगकर्ताओं को सिंक करने, ऐसे उपयोगकर्ता खोजने जिन्हें विश्लेषक की जाँच चाहिए, या डिस्प्ले नाम से खोजने के लिए करें।

कब उपयोग करें

  • आपकी उपयोगकर्ता तालिका को किसी बाहरी BI या वेयरहाउस में नियमित सिंक।
  • विश्लेषक कतारें: समीक्षा इनबॉक्स चलाने के लिए status=FLAGGED या पुराने last_activity_at से फ़िल्टर करें।
  • display_name, full_name, या vendor_data से उपयोगकर्ता खोजें।

फ़िल्टर और पेजिनेशन

नोट्स

  • हर रिस्पॉन्स आइटम में didit_internal_id शामिल होता है। जब मूल सत्र या लेन-देन ने कोई वेंडर डेटा नहीं दिया था, तो vendor_data null हो सकता है।
  • यह एंडपॉइंट कर्सर से पेजिनेट करता है: हर कॉल के बीच next कर्सर सहेजें, और जब next खाली हो तो रुक जाएँ।
  • उपयोगकर्ता की सभी फ़ील्ड्स के लिए उपयोगकर्ता डेटा मॉडल देखें।

अनुमतियाँ

एप्लिकेशन की कोई भी सक्रिय API कुंजी इस एंडपॉइंट को कॉल कर सकती है। Didit API कुंजियाँ एप्लिकेशन-स्कोप्ड हैं, भूमिका-स्कोप्ड नहीं: Console की भूमिकाएँ और अनुमतियाँ (list:users और बाकी) तय करती हैं कि कोई व्यक्ति Console में क्या कर सकता है, और Management API ट्रैफ़िक के लिए इनका मूल्यांकन नहीं होता। इस एंडपॉइंट को कौन कॉल कर सकता है, यह नियंत्रित करने के लिए तय करें कि एप्लिकेशन की API कुंजी कौन पढ़ सकता है।

संबंधित

प्राधिकरण

x-api-key
string
header
आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

क्वेरी पैरामीटर

limit
integer
डिफ़ॉल्ट:50

पेज का आकार। छोड़े जाने पर डिफ़ॉल्ट 50 होता है। कोई अनिवार्य अधिकतम सीमा नहीं है, लेकिन लेटेंसी के लिए पेजों को छोटा रखें।

आवश्यक सीमा: 1 <= x <= 1000000
offset
integer
डिफ़ॉल्ट:0

लौटाए जाने वाले पहले रिकॉर्ड का शून्य-आधारित ऑफ़सेट। इसे मैन्युअल रूप से गणना करने की तुलना में पिछले पृष्ठ से next URL का अनुसरण करना बेहतर है।

आवश्यक सीमा: 0 <= x <= 1000000

प्रतिक्रिया

सत्यापन स्थिति, सत्र गणना और सुविधा ब्रेकडाउन के साथ उपयोगकर्ताओं की पेजिनेटेड सूची।

count
integer

मिलान वाली पंक्तियों की संख्या — 100 तक सटीक, परफ़ॉर्मेंस के लिए उससे अधिक होने पर 100 पर सीमित। अंतिम पेज का पता लगाने के लिए इसका उपयोग न करें; इसके बजाय next के null होने पर निर्भर रहें।

next
string | null

अगले पेज का पूर्ण URL, या अंतिम पेज पर null।

previous
string | null

पिछले पेज का पूर्ण URL, या पहले पेज पर null।

results
object[]
अंतिम संशोधन 7 नवंबर 2026