List Data Masking

This API returns a list of masking functions available within the tenant.

---

Endpoint Details

URL	/v1/masking/functions
Method	GET
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Response

Here is an example of a response when viewing a list of data:

Response

{
    "items": [
        {
            "id": "da70e1b5-da18-47d1-8e49-ca4cbecbf174",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Dummy 4",
            "masking_character": "*",
            "masking_type": 4,
            "masking_start_position": 2,
            "masking_end_position": 1,
            "allow_special_character": true,
            "allow_white_space": true,
            "group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
            "description": "teesstt ni",
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_at": "2026-07-13T14:31:40+07:00",
            "updated_at": "2026-07-13T14:31:40+07:00",
            "assigned_user_ids": [
                "0a937c60-0ed4-4d06-870a-2e284b54287d"
            ]
        },
        {
            "id": "1e9c6609-96f0-4f8d-9b23-4be6a36796e8",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Dummy 3",
            "masking_character": "*",
            "masking_type": 3,
            "mask_percentage": 30,
            "group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
            "description": "teesstt ni",
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_at": "2026-07-13T14:29:31+07:00",
            "updated_at": "2026-07-13T14:29:31+07:00",
            "assigned_user_ids": [
                "0a937c60-0ed4-4d06-870a-2e284b54287d"
            ]
        },
        {
            "id": "bb15259d-4e91-45e4-8cd1-57bd323bec03",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Dummy 2",
            "masking_character": "*",
            "masking_type": 2,
            "partial_masking_option": 2,
            "group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
            "description": "teesstt ni",
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_at": "2026-07-13T14:27:40+07:00",
            "updated_at": "2026-07-13T14:27:40+07:00",
            "assigned_user_ids": [
                "0a937c60-0ed4-4d06-870a-2e284b54287d"
            ]
        },
        {
            "id": "f9cff6f3-362e-4b09-af3b-5b1f4ce90051",
            "tenant_id": "5ebde17c-01a1-4394-977b-9e611250cf5d",
            "name": "Dumy",
            "masking_character": "#",
            "masking_type": 2,
            "partial_masking_option": 1,
            "group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
            "created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
            "created_at": "2026-07-13T13:54:55+07:00",
            "updated_at": "2026-07-13T13:54:55+07:00",
            "assigned_user_ids": [
                "0a937c60-0ed4-4d06-870a-2e284b54287d"
            ]
        }
    ],
    "pagination": {
        "total": 4,
        "page": 1,
        "page_size": 4,
        "last_page": 1
    }
}

---

Field Descriptions

Field	Type	Description
id	UUID	Unique identifier of the masking function
tenant_id	UUID	Identifier of the tenant that owns the masking function
name	String	Name of the masking function
masking_character	String	Character used to mask the data
masking_type	Integer	Type of masking applied by the function
partial_masking_option	Integer	Position option used for partial masking
mask_percentage	Integer	Percentage of data masked, used for random masking
masking_start_position	Integer	Number of original characters shown at the beginning of the data
masking_end_position	Integer	Number of original characters shown at the end of the data
allow_special_character	Boolean	Indicates whether special characters are preserved from masking
allow_white_space	Boolean	Indicates whether white spaces are preserved from masking
group_id	UUID	Identifier of the associated group
description	String	Description of the masking function
created_by	UUID	Identifier of the user who created the function
updated_by	UUID	Identifier of the user who last updated the function
created_at	String	Creation timestamp in RFC 3339 date-time format
updated_at	String	Last update timestamp in RFC 3339 date-time format
assigned_user_ids	Array	List of user IDs assigned to the masking function
total	Integer	Total number of masking functions available
page	Integer	Current page number
page_size	Integer	Number of records returned per page
last_page	Integer	Total number of available pages

---

info

• A valid Bearer Token is required to access this endpoint.
• The response returns all masking functions available to the authenticated user within the tenant.
• Supported masking_type values are:
  • 1 = Full Masking
  • 2 = Partial Masking
  • 3 = Random Masking
  • 4 = Custom Masking
• Supported partial_masking_option values (used when masking_type is 2):
  • 1 = Prefix
  • 2 = Suffix
• Some fields such as partial_masking_option, mask_percentage, masking_start_position, and masking_end_position may not be present depending on the masking type configured.