GET/v1/groups
संगठन के ग्रुप की सूची पाएँ
list_groups
kind के बिना सामान्य ग्रुप, “All members” और रोल ग्रुप लौटाता है। निजी ग्रुप (single_user) सिर्फ़ स्पष्ट kind=single_user के साथ लौटते हैं। all_members, role और single_user ग्रुप की सदस्यता संगठन के यूज़र से निकाली जाती है, और उनका members_count भी।
ऑथेंटिकेशन
Authorization हेडर में API कुंजी भेजें: Authorization: Bearer <कुंजी>।
क्वेरी पैरामीटर
kindGroupKindlimitintegerपेज का आकार।
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
रिस्पॉन्स
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
idintegerज़रूरीorg_idintegerज़रूरीkeystringज़रूरीस्थिर कुंजी:
all,role:<role>,user:<id>या सामान्य ग्रुप की कुंजी। इंटरफ़ेस बिल्ट-इन ग्रुप का अनुवाद कुंजी के हिसाब से करता है।titlestringज़रूरीuser_idinteger | nullज़रूरीसिर्फ़ निजी ग्रुप के लिए।
सिर्फ़ रोल ग्रुप के लिए।
members_countintegerज़रूरीसक्रिय सदस्यों की संख्या। निष्क्रिय किए गए यूज़र ग्रुप के सदस्य नहीं होते।
disabledbooleanज़रूरीनिष्क्रिय किए गए यूज़र का निजी ग्रुप: इसके असाइनमेंट बने रहते हैं, पर यूज़र के निष्क्रिय रहने तक उनका कोई असर नहीं होता। बाक़ी सभी ग्रुप के लिए
false।created_atstring (date-time)ज़रूरीupdated_atstring (date-time)ज़रूरी
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
422वैलिडेशन एरर: बॉडी या पैरामीटर स्कीमा से मेल नहीं खाते (`detail` वैलिडेशन एरर की सूची है), या पैरामीटर का मान सीमा से बाहर है (`detail` एक संदेश है)।
रिस्पॉन्स हेडर
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 सेकंड में होता है: उतना इंतज़ार करें और रीट्राई करें।