This API is used to retrieve the details of the reward custom field metadata created for the org.

👍
Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Start time and end time are in UTC time zone

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/brand/customfield?sortBy=lastUpdatedOn&orderBy=DESC&scope=CATALOGUE_PROMOTION' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaHVMjU2YQ==' \
--header 'Cookie: _cfuvid=BNKMdc2rm4I7MYA3KIlxZDn.nhxE7URS3m2d4Ipaduo-1764062400363-0.0.1.1-604800000'

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/brand/customfield?sortBy=lastUpdatedOn' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaHVU2YQ==' \
--header 'Cookie: _cfuvid=BNKMdc2rm4I7MYA3KIlxZDn.nhxE7URS3m2d4Ipaduo-1764062400363-0.0.1.1-604800000'

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/brand/customfield?scope=REWARD' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaHV3MjU2YQ==' \
--header 'Cookie: _cfuvid=BNKMdc2rm4I7MYA3KIlxZDn.nhxE7URS3m2d4Ipaduo-1764062400363-0.0.1.1-604800000'

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/brand/customfield?scope=ISSUE_REWARD' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaI3MjU2YQ==' \
--header 'Cookie: _cfuvid=BNKMdc2rm4I7MYA3KIlxZDn.nhxE7URS3m2d4Ipaduo-1764062400363-0.0.1.1-604800000'

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/brand/customfield?scope=CATALOGUE_PROMOTION' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaH2YQ==' \
--header 'Cookie: _cfuvid=E9yUQiV1LNM8VWLgR6M1zGUxOIRX1pcceHtnyTeQ0LY-1764094406964-0.0.1.1-604800000'

Prerequisites

Authentication: Basic or OAuth authentication
Default access group

Resource information


URI	/api_gateway/rewards/core/v1/brand/customfield
HTTP Method	GET
Pagination	Yes
Batch support	No
Rate limit information	None

Request Query Parameters

Parameter Name

Data Type

Description

scope

String

Defines where the custom fields will be applicable:

REWARD: While creating or updating a reward.
CATALOGUE_PROMOTION: While creating or updating a promotion.
ISSUE_REWARD: While issuing a reward.

sortBy

Enum

Sorts the returned custom fields list. Supported values: lastUpdatedOn

orderBy

Enum

Specifies the order in which results should be sorted. Supported values: "ASC" for ascending, "DESC" for descending. Default value is "DESC".

Example response

[
    {
        "id": 32546,
        "orgId": 100737,
        "name": "terrorz",
        "description": "Custom Field of STRING Type",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75197372,
        "createdOn": 1763644000000,
        "createdOnDateTime": "2025-11-20T13:06:40Z",
        "lastUpdatedBy": 75197372,
        "lastUpdatedOn": 1763644000000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-11-20T13:06:40Z"
    },
    {
        "id": 32545,
        "orgId": 100737,
        "name": "terror",
        "description": "Custom Field of STRING Type",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75197372,
        "createdOn": 1763643953000,
        "createdOnDateTime": "2025-11-20T13:05:53Z",
        "lastUpdatedBy": 75197372,
        "lastUpdatedOn": 1763643953000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-11-20T13:05:53Z"
    },
    {
        "id": 28961,
        "orgId": 100737,
        "name": "UAT_CF_11",
        "description": "Custom Field of STRING Type",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757999610000,
        "createdOnDateTime": "2025-09-16T05:13:30Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757999610000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-16T05:13:30Z"
    },
    {
        "id": 28655,
        "orgId": 100737,
        "name": "UAT_CF_10",
        "description": "Custom Field of STRING Type + with isMandatory false + scope catalogue promotion",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": "false",
        "dataType": "BOOLEAN",
        "createdBy": 75155297,
        "createdOn": 1757503078000,
        "createdOnDateTime": "2025-09-10T11:17:58Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757998989000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-16T05:03:09Z"
    }
]

[
    {
        "id": 21682,
        "orgId": 100737,
        "name": "Address",
        "description": "Address to deliver reward",
        "isMandatory": false,
        "isActive": true,
        "scope": "ISSUE_REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75152721,
        "createdOn": 1746501773000,
        "createdOnDateTime": "2025-05-06T03:22:53Z",
        "lastUpdatedBy": 75152721,
        "lastUpdatedOn": 1746501773000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-05-06T03:22:53Z"
    },
    {
        "id": 21683,
        "orgId": 100737,
        "name": "Points Issued",
        "description": "Points issued to customer",
        "isMandatory": false,
        "isActive": true,
        "scope": "ISSUE_REWARD",
        "defaultValue": null,
        "dataType": "INTEGER",
        "createdBy": 75152721,
        "createdOn": 1746501974000,
        "createdOnDateTime": "2025-05-06T03:26:14Z",
        "lastUpdatedBy": 75152721,
        "lastUpdatedOn": 1746503356000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-05-06T03:49:16Z"
    }
]

[
    {
        "id": 18833,
        "orgId": 100737,
        "name": "CF1A_update",
        "description": "CF1A",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75152721,
        "createdOn": 1741847093000,
        "createdOnDateTime": "2025-03-13T06:24:53Z",
        "lastUpdatedBy": 75155282,
        "lastUpdatedOn": 1741886142000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-03-13T17:15:42Z"
    },
    {
        "id": 18836,
        "orgId": 100737,
        "name": "CF1A112",
        "description": "CF1A112",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155282,
        "createdOn": 1741850714000,
        "createdOnDateTime": "2025-03-13T07:25:14Z",
        "lastUpdatedBy": 75155282,
        "lastUpdatedOn": 1741850714000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-03-13T07:25:14Z"
    },
    {
        "id": 18880,
        "orgId": 100737,
        "name": "age_update",
        "description": "CF1A",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155282,
        "createdOn": 1741926993000,
        "createdOnDateTime": "2025-03-14T04:36:33Z",
        "lastUpdatedBy": 75155282,
        "lastUpdatedOn": 1741927126000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-03-14T04:38:46Z"
    },
    {
        "id": 21681,
        "orgId": 100737,
        "name": "Address",
        "description": "Address to deliver reward",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75152721,
        "createdOn": 1746501610000,
        "createdOnDateTime": "2025-05-06T03:20:10Z",
        "lastUpdatedBy": 75152721,
        "lastUpdatedOn": 1746501610000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-05-06T03:20:10Z"
    },
    {
        "id": 27563,
        "orgId": 100737,
        "name": "UAT_CF_1",
        "description": "Custom Field for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1755773599000,
        "createdOnDateTime": "2025-08-21T10:53:19Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1755773599000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-08-21T10:53:19Z"
    },
    {
        "id": 28635,
        "orgId": 100737,
        "name": "UAT_CF_2",
        "description": "Custom Field for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757486967000,
        "createdOnDateTime": "2025-09-10T06:49:27Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757486967000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T06:49:27Z"
    },
    {
        "id": 28638,
        "orgId": 100737,
        "name": "UAT_CF_3",
        "description": "Custom Field of Boolean Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "false",
        "dataType": "BOOLEAN",
        "createdBy": 75155297,
        "createdOn": 1757489222000,
        "createdOnDateTime": "2025-09-10T07:27:02Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757489222000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:27:02Z"
    },
    {
        "id": 28639,
        "orgId": 100737,
        "name": "UAT_CF_4",
        "description": "Custom Field of DATE Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "2025-09-10T07:00:00Z",
        "dataType": "DATE",
        "createdBy": 75155297,
        "createdOn": 1757489396000,
        "createdOnDateTime": "2025-09-10T07:29:56Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757489396000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:29:56Z"
    },
    {
        "id": 28640,
        "orgId": 100737,
        "name": "UAT_CF_5",
        "description": "Custom Field of INTEGER Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "10",
        "dataType": "INTEGER",
        "createdBy": 75155297,
        "createdOn": 1757489651000,
        "createdOnDateTime": "2025-09-10T07:34:11Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757489651000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:34:11Z"
    },
    {
        "id": 28641,
        "orgId": 100737,
        "name": "UAT_CF_6",
        "description": "Custom Field of STRING Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has su",
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757490012000,
        "createdOnDateTime": "2025-09-10T07:40:12Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757490012000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:40:12Z"
    },
    {
        "id": 28642,
        "orgId": 100737,
        "name": "UAT_CF_7",
        "description": "Custom Field of STRING Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has su",
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757490081000,
        "createdOnDateTime": "2025-09-10T07:41:21Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757490081000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:41:21Z"
    },
    {
        "id": 28647,
        "orgId": 100737,
        "name": "UAT_CF_8",
        "description": "Custom Field of ENUM Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "PAID",
        "dataType": "ENUM",
        "createdBy": 75155297,
        "createdOn": 1757495943000,
        "createdOnDateTime": "2025-09-10T09:19:03Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757495943000,
        "enumValues": [
            "FREE",
            "PAID"
        ],
        "lastUpdatedOnDateTime": "2025-09-10T09:19:03Z"
    },
    {
        "id": 28651,
        "orgId": 100737,
        "name": "983734628",
        "description": "Custom Field of STRING Type + with integer as name",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757499293000,
        "createdOnDateTime": "2025-09-10T10:14:53Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757499293000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T10:14:53Z"
    },
    {
        "id": 28652,
        "orgId": 100737,
        "name": "&^%^%",
        "description": "Custom Field of STRING Type + with integer as name",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757499667000,
        "createdOnDateTime": "2025-09-10T10:21:07Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757499667000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T10:21:07Z"
    }
]

[
    {
        "id": 28655,
        "orgId": 100737,
        "name": "UAT_CF_10",
        "description": "Custom Field of STRING Type + with isMandatory false + scope catalogue promotion",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": "false",
        "dataType": "BOOLEAN",
        "createdBy": 75155297,
        "createdOn": 1757503078000,
        "createdOnDateTime": "2025-09-10T11:17:58Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757998989000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-16T05:03:09Z"
    },
    {
        "id": 28961,
        "orgId": 100737,
        "name": "UAT_CF_11",
        "description": "Custom Field of STRING Type",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757999610000,
        "createdOnDateTime": "2025-09-16T05:13:30Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757999610000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-16T05:13:30Z"
    },
    {
        "id": 32545,
        "orgId": 100737,
        "name": "terror",
        "description": "Custom Field of STRING Type",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75197372,
        "createdOn": 1763643953000,
        "createdOnDateTime": "2025-11-20T13:05:53Z",
        "lastUpdatedBy": 75197372,
        "lastUpdatedOn": 1763643953000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-11-20T13:05:53Z"
    },
    {
        "id": 32546,
        "orgId": 100737,
        "name": "terrorz",
        "description": "Custom Field of STRING Type",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75197372,
        "createdOn": 1763644000000,
        "createdOnDateTime": "2025-11-20T13:06:40Z",
        "lastUpdatedBy": 75197372,
        "lastUpdatedOn": 1763644000000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-11-20T13:06:40Z"
    }
]

[
    {
        "id": 32546,
        "orgId": 100737,
        "name": "terrorz",
        "description": "Custom Field of STRING Type",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75197372,
        "createdOn": 1763644000000,
        "createdOnDateTime": "2025-11-20T13:06:40Z",
        "lastUpdatedBy": 75197372,
        "lastUpdatedOn": 1763644000000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-11-20T13:06:40Z"
    },
    {
        "id": 32545,
        "orgId": 100737,
        "name": "terror",
        "description": "Custom Field of STRING Type",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75197372,
        "createdOn": 1763643953000,
        "createdOnDateTime": "2025-11-20T13:05:53Z",
        "lastUpdatedBy": 75197372,
        "lastUpdatedOn": 1763643953000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-11-20T13:05:53Z"
    },
    {
        "id": 28961,
        "orgId": 100737,
        "name": "UAT_CF_11",
        "description": "Custom Field of STRING Type",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757999610000,
        "createdOnDateTime": "2025-09-16T05:13:30Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757999610000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-16T05:13:30Z"
    },
    {
        "id": 28655,
        "orgId": 100737,
        "name": "UAT_CF_10",
        "description": "Custom Field of STRING Type + with isMandatory false + scope catalogue promotion",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": "false",
        "dataType": "BOOLEAN",
        "createdBy": 75155297,
        "createdOn": 1757503078000,
        "createdOnDateTime": "2025-09-10T11:17:58Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757998989000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-16T05:03:09Z"
    },
    {
        "id": 28652,
        "orgId": 100737,
        "name": "&^%^%",
        "description": "Custom Field of STRING Type + with integer as name",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757499667000,
        "createdOnDateTime": "2025-09-10T10:21:07Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757499667000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T10:21:07Z"
    },
    {
        "id": 28651,
        "orgId": 100737,
        "name": "983734628",
        "description": "Custom Field of STRING Type + with integer as name",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757499293000,
        "createdOnDateTime": "2025-09-10T10:14:53Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757499293000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T10:14:53Z"
    },
    {
        "id": 28647,
        "orgId": 100737,
        "name": "UAT_CF_8",
        "description": "Custom Field of ENUM Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "PAID",
        "dataType": "ENUM",
        "createdBy": 75155297,
        "createdOn": 1757495943000,
        "createdOnDateTime": "2025-09-10T09:19:03Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757495943000,
        "enumValues": [
            "FREE",
            "PAID"
        ],
        "lastUpdatedOnDateTime": "2025-09-10T09:19:03Z"
    },
    {
        "id": 28642,
        "orgId": 100737,
        "name": "UAT_CF_7",
        "description": "Custom Field of STRING Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has su",
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757490081000,
        "createdOnDateTime": "2025-09-10T07:41:21Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757490081000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:41:21Z"
    },
    {
        "id": 28641,
        "orgId": 100737,
        "name": "UAT_CF_6",
        "description": "Custom Field of STRING Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has su",
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757490012000,
        "createdOnDateTime": "2025-09-10T07:40:12Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757490012000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:40:12Z"
    },
    {
        "id": 28640,
        "orgId": 100737,
        "name": "UAT_CF_5",
        "description": "Custom Field of INTEGER Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "10",
        "dataType": "INTEGER",
        "createdBy": 75155297,
        "createdOn": 1757489651000,
        "createdOnDateTime": "2025-09-10T07:34:11Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757489651000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:34:11Z"
    },
    {
        "id": 28639,
        "orgId": 100737,
        "name": "UAT_CF_4",
        "description": "Custom Field of DATE Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "2025-09-10T07:00:00Z",
        "dataType": "DATE",
        "createdBy": 75155297,
        "createdOn": 1757489396000,
        "createdOnDateTime": "2025-09-10T07:29:56Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757489396000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:29:56Z"
    },
    {
        "id": 28638,
        "orgId": 100737,
        "name": "UAT_CF_3",
        "description": "Custom Field of Boolean Type + Not mandatory for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "false",
        "dataType": "BOOLEAN",
        "createdBy": 75155297,
        "createdOn": 1757489222000,
        "createdOnDateTime": "2025-09-10T07:27:02Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757489222000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T07:27:02Z"
    },
    {
        "id": 28635,
        "orgId": 100737,
        "name": "UAT_CF_2",
        "description": "Custom Field for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1757486967000,
        "createdOnDateTime": "2025-09-10T06:49:27Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1757486967000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-09-10T06:49:27Z"
    },
    {
        "id": 27563,
        "orgId": 100737,
        "name": "UAT_CF_1",
        "description": "Custom Field for UAT",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155297,
        "createdOn": 1755773599000,
        "createdOnDateTime": "2025-08-21T10:53:19Z",
        "lastUpdatedBy": 75155297,
        "lastUpdatedOn": 1755773599000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-08-21T10:53:19Z"
    },
    {
        "id": 21683,
        "orgId": 100737,
        "name": "Points Issued",
        "description": "Points issued to customer",
        "isMandatory": false,
        "isActive": true,
        "scope": "ISSUE_REWARD",
        "defaultValue": null,
        "dataType": "INTEGER",
        "createdBy": 75152721,
        "createdOn": 1746501974000,
        "createdOnDateTime": "2025-05-06T03:26:14Z",
        "lastUpdatedBy": 75152721,
        "lastUpdatedOn": 1746503356000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-05-06T03:49:16Z"
    },
    {
        "id": 21682,
        "orgId": 100737,
        "name": "Address",
        "description": "Address to deliver reward",
        "isMandatory": false,
        "isActive": true,
        "scope": "ISSUE_REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75152721,
        "createdOn": 1746501773000,
        "createdOnDateTime": "2025-05-06T03:22:53Z",
        "lastUpdatedBy": 75152721,
        "lastUpdatedOn": 1746501773000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-05-06T03:22:53Z"
    },
    {
        "id": 21681,
        "orgId": 100737,
        "name": "Address",
        "description": "Address to deliver reward",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75152721,
        "createdOn": 1746501610000,
        "createdOnDateTime": "2025-05-06T03:20:10Z",
        "lastUpdatedBy": 75152721,
        "lastUpdatedOn": 1746501610000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-05-06T03:20:10Z"
    },
    {
        "id": 18880,
        "orgId": 100737,
        "name": "age_update",
        "description": "CF1A",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155282,
        "createdOn": 1741926993000,
        "createdOnDateTime": "2025-03-14T04:36:33Z",
        "lastUpdatedBy": 75155282,
        "lastUpdatedOn": 1741927126000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-03-14T04:38:46Z"
    },
    {
        "id": 18833,
        "orgId": 100737,
        "name": "CF1A_update",
        "description": "CF1A",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75152721,
        "createdOn": 1741847093000,
        "createdOnDateTime": "2025-03-13T06:24:53Z",
        "lastUpdatedBy": 75155282,
        "lastUpdatedOn": 1741886142000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-03-13T17:15:42Z"
    },
    {
        "id": 18836,
        "orgId": 100737,
        "name": "CF1A112",
        "description": "CF1A112",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75155282,
        "createdOn": 1741850714000,
        "createdOnDateTime": "2025-03-13T07:25:14Z",
        "lastUpdatedBy": 75155282,
        "lastUpdatedOn": 1741850714000,
        "enumValues": null,
        "lastUpdatedOnDateTime": "2025-03-13T07:25:14Z"
    }
]

Response parameters

Parameter Name	Data Type	Description
`id`	Integer	A unique identifier for the custom field.
`orgId`	Integer	The unique identifier of the organization.
`name`	String	A unique name for the custom field.
`description`	String	A description of the custom field.
`isMandatory`	Boolean	Indicates if the custom field is mandatory. Possible values: `true` (mandatory) or `false` (optional, default).
`isActive`	Boolean	Indicates the status of the custom field. Possible values: `true` (active, default) or `false` (inactive).
`scope`	String	Indicates where the additional custom fields will apply. Possible values: `REWARD` (while creating or updating a reward), `ISSUE_REWARD` (while issuing a reward), `CATALOGUE_PROMOTION` (while creating or updating a promotion).
`defaultValue`	Null	The default value for the custom field, used when no value is specified.
`dataType`	String	The type of data for the custom field. Possible values: `BOOLEAN`, `ENUM`, `DATE`, `STRING`, `INTEGER`.
`createdBy`	Integer	The unique customer identifier of the user who created the custom field.
`createdOn`	Date	The creation date and time of the field in Epoch time format.
`createdOnDateTime`	String	The creation date and time of the field in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
`lastUpdatedBy`	Integer	The unique customer identifier of the user who last updated the custom field.
`lastUpdatedOn`	Date	The last updated date and time of the field in Epoch time format.
`enumValues`	Object	An object containing the enum values.
`lastUpdatedOnDateTime`	String	The last updated date and time of the field in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).