GET/v1/folders
सभी कलेक्शन के फ़ोल्डर ट्री पाएँ
folder_trees
एक रिस्पॉन्स में उन सभी कलेक्शन के फ़ोल्डर ट्री लौटाता है, जहाँ यूज़र कम से कम एक ऑब्जेक्ट देख सकता है, GET /v1/collections/{name}/folders वाले दृश्यता नियमों के साथ और GET /v1/collections के क्रम में। बिना दिखने वाले ऑब्जेक्ट का कलेक्शन शामिल नहीं होता। cards के अलावा हर फ़ोल्डर में सब-ट्री के योग cards_total, sensitive_total और top_category होते हैं। updated_since या metadata[<key>]= के साथ हर कलेक्शन के folders में मेल खाने वाले फ़ोल्डर सपाट सूची के रूप में होते हैं (children ख़ाली होता है, और parent_id ट्री में जगह बताता है)। updated_since के साथ वे updated_at के बढ़ते क्रम में, फिर id के क्रम में सॉर्ट होते हैं; उसके बिना sort_key के क्रम में। जिन कलेक्शन में मेल खाने वाले फ़ोल्डर नहीं हैं, वे शामिल नहीं होते।
ऑथेंटिकेशन
Authorization हेडर में API कुंजी भेजें: Authorization: Bearer <कुंजी>।
क्वेरी पैरामीटर
limitintegerपेज का आकार।
limitऔरcursorके बिना पूरी सूची लौटती है; इसके साथ ज़्यादा से ज़्यादाlimitआइटम, और अगला पेजLink(rel="next") औरX-Next-Cursorहेडर में दिया जाता है।≥ 1, ≤ 200
cursorstringअगले पेज का कर्सर,
X-Next-Cursorसे या उन्हीं फ़िल्टर वाले पिछले रिस्पॉन्स केnext_cursorसे; इसमें पेज का आकार शामिल होता है।offsetके साथ:422 validation.failed; दूसरी सूची का, दूसरे फ़िल्टर वाला या ख़राब कर्सर:400 api.cursor_invalid।length ≤ 512
updated_sincestring (date-time)सिर्फ़ वे ऑब्जेक्ट, जिनका
updated_atइस पल पर या उसके बाद का है (ऑफ़सेट के साथ RFC 3339), सिंक के लिए। इसके साथ सूचीupdated_atके बढ़ते क्रम में, फिरidके क्रम में सॉर्ट होती है, और कर्सर इसी क्रम में आगे बढ़ता है। हटाए गए ऑब्जेक्ट सूची में नहीं आते: डिलीशन इवेंट के रूप में आते हैं।length ≤ 512
metadatamap of stringmetadataसे फ़िल्टर:metadata[<key>]=<value>सिर्फ़ पूरे मेल पर चुनता है। ज़्यादा से ज़्यादा 3 शर्तें, और सभी पूरी होनी चाहिए (?metadata[team]=support&metadata[crm_id]=A-1042)। 3 से ज़्यादा शर्तें या अमान्य कुंजी होने पर400 api.metadata_invalidलौटता है।
रिस्पॉन्स
200सफल रिस्पॉन्स
रिस्पॉन्स हेडर
Linkअगले पेज का पता,
<…>; rel="next"। हेडर न हो, तो यह आख़िरी पेज है।X-Next-Cursorcursorपैरामीटर के लिए अगले पेज का कर्सर। हेडर न हो, तो यह आख़िरी पेज है।RateLimit-Policyलागू सीमाएँ, IETF ड्राफ़्ट
draft-ietf-httpapi-ratelimit-headersके फ़ॉर्मेट में: कॉमा से अलग आइटम"<name>";q=<quota>;w=<window in seconds>।keyAPI कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यहuserहै, बिना क्रेडेंशियल केip);minute,dayऔरmonthUTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।RateLimitRateLimit-Policyकी हर सीमा में से कितना बचा है:"<name>";r=<remaining>;t=<seconds until reset>।X-RateLimit-LimitRateLimit-Policyकी सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।X-RateLimit-Remainingसबसे सख़्त सीमा में बची रिक्वेस्ट।
X-RateLimit-Resetसबसे सख़्त सीमा के रीसेट होने तक के सेकंड।
application/json
collection_idintegerज़रूरीcollection_namestringज़रूरीcollection_titlestringज़रूरीदिखाने के लिए कलेक्शन का नाम।
permissionsarray of stringज़रूरीकलेक्शन पर यूज़र की असल अनुमतियाँ।
unfiledintegerज़रूरीकलेक्शन के वे कार्ड, जो यूज़र को उपलब्ध हैं और किसी फ़ोल्डर में नहीं हैं। आर्काइव किए गए कार्ड नहीं गिने जाते, जैसे डिफ़ॉल्ट कार्ड सूची में।
401कोई क्रेडेंशियल नहीं भेजा गया (न सेशन कुकी, न API कुंजी), या कुंजी नहीं मिली।
रिस्पॉन्स हेडर
RateLimit-Policyलागू सीमाएँ, IETF ड्राफ़्ट
draft-ietf-httpapi-ratelimit-headersके फ़ॉर्मेट में: कॉमा से अलग आइटम"<name>";q=<quota>;w=<window in seconds>।keyAPI कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यहuserहै, बिना क्रेडेंशियल केip);minute,dayऔरmonthUTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।RateLimitRateLimit-Policyकी हर सीमा में से कितना बचा है:"<name>";r=<remaining>;t=<seconds until reset>।X-RateLimit-LimitRateLimit-Policyकी सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।X-RateLimit-Remainingसबसे सख़्त सीमा में बची रिक्वेस्ट।
X-RateLimit-Resetसबसे सख़्त सीमा के रीसेट होने तक के सेकंड।
application/json
429बहुत ज़्यादा रिक्वेस्ट (`api.rate_limited`), संगठन का मिनट, दिन या महीने का कोटा ख़त्म हो गया है (`api.quota_exceeded`; `error.details` में `quota`, `limit` और `reset_at` होते हैं), संगठन की सीमा पूरी हो गई है, या जवाब देने वाली सर्विस व्यस्त है (`answers.engine_busy`)। `Retry-After` हेडर में दिए गए समय तक इंतज़ार करें।
रिस्पॉन्स हेडर
Retry-Afterरिक्वेस्ट का रीट्राई करने से पहले कितने सेकंड इंतज़ार करना है।
RateLimit-Policyलागू सीमाएँ, IETF ड्राफ़्ट
draft-ietf-httpapi-ratelimit-headersके फ़ॉर्मेट में: कॉमा से अलग आइटम"<name>";q=<quota>;w=<window in seconds>।keyAPI कुंजी की रिक्वेस्ट दर है (कोटा बर्स्ट है, विंडो उसके पूरी तरह भरने का समय है; सेशन के लिए यहuserहै, बिना क्रेडेंशियल केip);minute,dayऔरmonthUTC में कैलेंडर मिनट, दिन और महीने के लिए संगठन के कोटा हैं।RateLimitRateLimit-Policyकी हर सीमा में से कितना बचा है:"<name>";r=<remaining>;t=<seconds until reset>।X-RateLimit-LimitRateLimit-Policyकी सबसे सख़्त एंट्री की सीमा (जिसमें सबसे कम रिक्वेस्ट बची हैं)।X-RateLimit-Remainingसबसे सख़्त सीमा में बची रिक्वेस्ट।
X-RateLimit-Resetसबसे सख़्त सीमा के रीसेट होने तक के सेकंड।
application/json
एरर कोड
हर रिक्वेस्ट के सामान्य कोड के अलावा वे कोड, जो यह एंडपॉइंट एरर होने पर error.code में लौटा सकता है।
रेट लिमिट
रिस्पॉन्स में RateLimit और RateLimit-Policy हेडर होते हैं, और पहले वाले X-RateLimit-Limit, X-RateLimit-Remaining और X-RateLimit-Reset भी। 429 रिस्पॉन्स में Retry-After सेकंड में होता है: उतना इंतज़ार करें और रीट्राई करें।