Chuyển tới nội dung
Sursa Developers

GET/v1/groups

Liệt kê nhóm của tổ chức

list_groups

Khi không có kind, trả về các nhóm thông thường, “All members” và các nhóm theo vai trò. Nhóm cá nhân (single_user) chỉ được trả về khi chỉ định rõ kind=single_user. Thành viên của các nhóm all_members, role và single_user được tính từ người dùng của tổ chức, members_count của các nhóm này cũng vậy.

Xác thực

Gửi khóa API trong header Authorization: Authorization: Bearer <khóa>.

Tham số truy vấn

  • kindGroupKind
  • limitinteger

    Kích thước trang. Khi không có limit và cursor, toàn bộ danh sách được trả về; khi có, trả về tối đa limit phần tử, và trang tiếp theo được cho trong các header Link (rel="next") và X-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    Con trỏ của trang tiếp theo, lấy từ X-Next-Cursor hoặc next_cursor của phản hồi trước với cùng bộ lọc; con trỏ mang theo kích thước trang. Dùng cùng với offset: 422 validation.failed; con trỏ của danh sách khác, của bộ lọc khác hoặc sai định dạng: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    Chỉ các đối tượng có updated_at tại hoặc sau thời điểm này (RFC 3339 có độ lệch múi giờ), dùng để đồng bộ. Khi có tham số này, danh sách được sắp xếp theo updated_at tăng dần, rồi theo id, và con trỏ tiếp tục theo thứ tự đó. Đối tượng đã bị xóa không được liệt kê: thao tác xóa được báo bằng sự kiện.

    length ≤ 512

Phản hồi

200Phản hồi thành công

Header phản hồi

  • Link

    Địa chỉ của trang tiếp theo, <…>; rel="next". Không có header nghĩa là đây là trang cuối.

  • X-Next-Cursor

    Con trỏ của trang tiếp theo cho tham số cursor. Không có header nghĩa là đây là trang cuối.

  • RateLimit-Policy

    Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.

  • RateLimit

    Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).

  • X-RateLimit-Remaining

    Số yêu cầu còn lại theo giới hạn chặt nhất.

  • X-RateLimit-Reset

    Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: GroupList

array of Group
  • idintegerbắt buộc
  • org_idintegerbắt buộc
  • keystringbắt buộc

    Khóa ổn định: all, role:<role>, user:<id> hoặc khóa của một nhóm thường. Giao diện dịch tên các nhóm có sẵn theo khóa.

  • titlestringbắt buộc
  • kindGroupKindbắt buộc
  • user_idinteger | nullbắt buộc

    Chỉ với nhóm cá nhân.

  • role_keyRole | nullbắt buộc

    Chỉ với nhóm theo vai trò.

  • managed_byGroupManagedBybắt buộc
  • members_countintegerbắt buộc

    Số thành viên đang hoạt động. Người dùng đã bị vô hiệu hóa không phải là thành viên của nhóm.

  • disabledbooleanbắt buộc

    Nhóm cá nhân của người dùng đã bị vô hiệu hóa: các lượt gán của nhóm được giữ lại nhưng không có hiệu lực khi người dùng không hoạt động. false với mọi nhóm khác.

  • created_atstring (date-time)bắt buộc
  • updated_atstring (date-time)bắt buộc
401Không có thông tin xác thực nào được gửi (không có cookie phiên lẫn khóa API), hoặc không tìm thấy khóa.

Header phản hồi

  • RateLimit-Policy

    Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.

  • RateLimit

    Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).

  • X-RateLimit-Remaining

    Số yêu cầu còn lại theo giới hạn chặt nhất.

  • X-RateLimit-Reset

    Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: Error

422Lỗi dữ liệu không hợp lệ: phần thân hoặc tham số không khớp với lược đồ (`detail` là danh sách lỗi dữ liệu không hợp lệ), hoặc giá trị tham số nằm ngoài phạm vi cho phép (`detail` là thông báo).

Header phản hồi

  • RateLimit-Policy

    Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.

  • RateLimit

    Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).

  • X-RateLimit-Remaining

    Số yêu cầu còn lại theo giới hạn chặt nhất.

  • X-RateLimit-Reset

    Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: Error

429Quá nhiều yêu cầu (`api.rate_limited`), hạn mức của tổ chức theo phút, ngày hoặc tháng đã dùng hết (`api.quota_exceeded`; `error.details` chứa `quota`, `limit` và `reset_at`), tổ chức đã đạt giới hạn, hoặc dịch vụ trả lời đang bận (`answers.engine_busy`). Hãy chờ khoảng thời gian ghi trong header `Retry-After`.

Header phản hồi

  • Retry-After

    Số giây cần chờ trước khi thử lại yêu cầu.

  • RateLimit-Policy

    Các giới hạn đang áp dụng, theo định dạng của bản dự thảo IETF draft-ietf-httpapi-ratelimit-headers: các mục phân tách bằng dấu phẩy "<name>";q=<quota>;w=<window in seconds>. key là tốc độ yêu cầu của khóa API (hạn mức là đợt tăng đột biến, khung thời gian là thời gian để hạn mức hồi lại hoàn toàn; với phiên là user, khi không có thông tin xác thực là ip); minute, day và month là hạn mức của tổ chức cho phút, ngày và tháng theo lịch, tính theo UTC.

  • RateLimit

    Phần còn lại của mỗi giới hạn trong RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    Giới hạn của mục chặt nhất trong RateLimit-Policy (mục còn ít yêu cầu nhất).

  • X-RateLimit-Remaining

    Số yêu cầu còn lại theo giới hạn chặt nhất.

  • X-RateLimit-Reset

    Số giây cho đến khi giới hạn chặt nhất được đặt lại.

application/json

Đối tượng: Error

Mã lỗi

Các mã endpoint này có thể trả về trong error.code, ngoài các mã chung của mọi yêu cầu.

Giới hạn tốc độ

Phản hồi có các header RateLimit và RateLimit-Policy cùng các header cũ hơn X-RateLimit-Limit, X-RateLimit-Remaining và X-RateLimit-Reset. Phản hồi 429 có Retry-After tính bằng giây: hãy chờ rồi thử lại.

← groups · Tài liệu tham chiếu API