Get list of user groups

Updated date: 30/04/2023
Updated by: VNPT eContract's team

---

Purpose

Function to get the list of user groups in the company

• Request URL: /api/user-groups
• HTTP method: GET
• Authorize: Bearer token
• Parameter: Not required, but additional options can be added below to filter or search the list of user group..

Key	Type	Description
search	string	Search information by Code of user group
page	int	Page number (default is 1)
pagesize	int	Page size (default is 10 records)

Sample request

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

Sample 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": []
}