Get list of roles

Updated date: 18/08/2026
Updated by: VNPT eContract's team

---

Purpose

Function to retrieve the list of roles of a user in the current company

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

Key	Type	Description
search	string	Search information by role code or role name
page	int	Page number (default is 1)
pagesize	int	Page size (default is 10 records)

Sample request

Query param:
    page: 1
    pageSize: 10
    search: Default
Request: /api/roles?page=1&pageSize=10&search=Default

Sample response body

{
    "data": {
        "items": [
            {
                "id": "2b999cd0-32ec-4e4a-16b8-08da6df5fc5a",
                "code": "Default",
                "name": "Default role",
                "description": "Default role with permissions to create, duplicate, and process documents."
            }
        ],
        "totalCount": 1,
        "pageCount": 1,
        "page": 1,
        "pageSize": 10,
        "hasNextPage": false,
        "hasPreviousPage": false
    },
    "success": true,
    "code": 0,
    "messages": []
}

Response Body Description

Key	Type	Description
success	boolean	Response status (true: Success, false: Failure)
code	int	Response code from the system
messages	array	List of messages returned by the system
data	object	Object containing the list of roles and pagination data (see details below)

---

Details of data:

Key	Type	Description
items	array	List of detailed role information (see details below)
totalCount	int	Total number of roles matching the filter criteria
pageCount	int	Total number of pages
page	int	Current page
pageSize	int	Number of records per page
hasNextPage	boolean	Whether there is a next page (true: Yes, false: No)
hasPreviousPage	boolean	Whether there is a previous page (true: Yes, false: No)

---

Details of objects in the items array:

Key	Type	Description
id	string	Role ID (GUID format)
code	string	Role code (e.g., Default)
name	string	Role name (e.g., Default)
description	string	Detailed description of the role's permissions or scope