Lấy danh sách nhóm người dùng

Ngày cập nhật: 18 tháng 08, 2026
Người cập nhật: VNPT eContract's team

---

Mục đích

Hàm thực hiện lấy danh sách nhóm người dùng của công ty

• Request URL: /api/user-groups
• HTTP method: GET
• Authorize: Bearer token
• Parameter: Không yêu cầu, tuy nhiên có thể thêm các tùy chọn bên dưới để thực hiện lọc hoặc tìm kiếm danh sách nhóm người dùng

Key	Type	Description
search	string	Thông tin tìm kiếm theo mã nhóm người dùng
page	int	Số trang cần lấy dữ liệu (Mặc định hệ thống đang là 1)
pagesize	int	Số record dữ liệu mà hệ thống sẽ trả về sau mỗi request (Mặc định hệ thống đang là 10 record)

Mẫu request

Query param:
    page: 1
    pageSize: 10
    search: USER
Request: /api/user-groups?page=1&pageSize=10&search=USER

Mẫu response body

{
    "data": {
        "items": [
            {
                "id": 11,
                "code": "USER",
                "name": "Nhóm người dùng thông thường",
                "users": [
                    {
                        "id": 123,
                        "comId": 164,
                        "isValid": false,
                        "signConfirmationEnabled": false,
                        "isAccountLocked": false,
                        "signMethod": {
                            "value": 0,
                            "description": "0"
                        },
                        "status": {
                            "value": 0,
                            "description": "0"
                        },
                        "receiveOtpMethod": {
                            "value": 0,
                            "description": "0"
                        },
                        "receiveNotificationMethod": {
                            "value": 0,
                            "description": "Email"
                        }
                    }
                ]
            }
        ],
        "totalCount": 1,
        "pageCount": 1,
        "page": 1,
        "pageSize": 10,
        "hasNextPage": false,
        "hasPreviousPage": false
    },
    "success": true,
    "code": 0,
    "messages": []
}

ghi chú

Đối tượng user đã được rút gọn chỉ hiển thị một số trường quan trọng nhất. Để xem chi tiết thông tin người dùng, vui lòng tham khảo API lấy thông tin người dùng theo ID

Mô tả Response Body

Key	Type	Description
success	boolean	Trạng thái phản hồi của yêu cầu (true: Thành công, false: Thất bại)
code	int	Mã phản hồi từ hệ thống
messages	array	Danh sách thông báo trả về từ hệ thống
data	object	Đối tượng chứa danh sách nhóm người dùng và dữ liệu phân trang (xem chi tiết bên dưới)

---

Chi tiết dữ liệu trong data:

Key	Type	Description
items	array	Danh sách thông tin chi tiết các nhóm người dùng (xem chi tiết bên dưới)
totalCount	int	Tổng số lượng nhóm người dùng thỏa mãn điều kiện lọc
pageCount	int	Tổng số trang
page	int	Trang hiện tại
pageSize	int	Số lượng bản ghi trên một trang
hasNextPage	boolean	Có trang kế tiếp hay không (true: Có, false: Không)
hasPreviousPage	boolean	Có trang trước đó hay không (true: Có, false: Không)

---

Chi tiết đối tượng trong mảng items:

Key	Type	Description
id	int	ID của nhóm người dùng
code	string	Mã nhóm người dùng (ví dụ: USER)
name	string	Tên nhóm người dùng
users	array	Danh sách người dùng thuộc nhóm (xem chi tiết thông tin người dùng)