get https://{host}/api_gateway/rewards/core/v1/brand/customfield
This API is used to retrieve the details of the 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
Prerequisites
- Basic Authentication
- Default access group
Resource information
| URI | /api_gateway/rewards/core/v1/brand/customfield |
| HTTP Method | GET |
| Pagination | No |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/brand/customfield
Response parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| id | Integer | Unique identifier for the custom field |
| orgId | Integer | Org identifier of the org. |
| name | String | Name of the custom field. |
| description | String | Description of the custom field. |
| isMandatory | Boolean | Indicates if the field is mandatory. |
| isActive | Boolean | Status of the field. |
| scope | String | Scope of the field. |
| defaultValue | Null | Default value of the field. |
| dataType | String | Type of data for the field. |
| createdBy | Integer | User identifier who created the field |
| createdOn | Long | The time when the custom field is created. |
| lastUpdatedBy | Integer | User identifier who last updated the field. |
| lastUpdatedOn | Long | Last update date and time of the field. |
[
{
"id": 1,
"orgId": 100458,
"name": "RANDOM1",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": null,
"createdOn": 1682517443000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1700826176000
},
{
"id": 2,
"orgId": 100458,
"name": "CF2",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1682518499000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1682518499000
},
{
"id": 3,
"orgId": 100458,
"name": "CF3",
"description": "CF3 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1682518550000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1682518550000
},
{
"id": 4,
"orgId": 100458,
"name": "CF4",
"description": "CF4 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1683197909000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1683197909000
},
{
"id": 5,
"orgId": 100458,
"name": "CF5",
"description": "CF5 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1683219012000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1683219012000
},
{
"id": 6,
"orgId": 100458,
"name": "CF7",
"description": "CF3 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": "YES",
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1694064657000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1694064657000
},
{
"id": 7,
"orgId": 100458,
"name": "CF9",
"description": "CF3 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": "YES",
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1694064678000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1694064678000
},
{
"id": 8,
"orgId": 100458,
"name": "CD4",
"description": "CF3 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1694069502000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1694069502000
},
{
"id": 9,
"orgId": 100458,
"name": "Customfield1",
"description": "CF3 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": "YES",
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1694623262000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1694623262000
},
{
"id": 10,
"orgId": 100458,
"name": "CF11",
"description": "CF3 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1695706264000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1695706264000
},
{
"id": 11,
"orgId": 100458,
"name": "CF12",
"description": "CF12 Test",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": null,
"createdOn": 1695706897000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1695711772000
},
{
"id": 12,
"orgId": 100458,
"name": "CF90",
"description": "CF90 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1696409423000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1696409423000
},
{
"id": 13,
"orgId": 100458,
"name": "CF91",
"description": "CF3 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1696409435000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1696409435000
},
{
"id": 44,
"orgId": 100458,
"name": "CF1",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1700545490000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1700545490000
},
{
"id": 57,
"orgId": 100458,
"name": "rohan",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1700752364000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1700752364000
},
{
"id": 58,
"orgId": 100458,
"name": "test1",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1700754045000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1700754045000
},
{
"id": 59,
"orgId": 100458,
"name": "RANDOM11",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": null,
"createdOn": 1700754054000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1700826205000
},
{
"id": 60,
"orgId": 100458,
"name": "finalTest",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": null,
"createdOn": 1700756008000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1700764155000
},
{
"id": 61,
"orgId": 100458,
"name": "RANDOM111",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": null,
"createdOn": 1700756195000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1700826243000
},
{
"id": 62,
"orgId": 100458,
"name": "finalTest1",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": null,
"createdOn": 1700756272000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1700756286000
},
{
"id": 87,
"orgId": 100458,
"name": "CF1",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "CATALOGUE_PROMOTION",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1701863921000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1701863921000
},
{
"id": 106,
"orgId": 100458,
"name": "CF1A_update",
"description": "CF1A",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": null,
"createdOn": 1702624272000,
"lastUpdatedBy": 75086856,
"lastUpdatedOn": 1702624319000
},
{
"id": 207,
"orgId": 100458,
"name": "CF1A12",
"description": "CF1A12",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1706842068000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1706842068000
},
{
"id": 208,
"orgId": 100458,
"name": "CF1A123",
"description": "CF1A123",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75078478,
"createdOn": 1706842169000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1706842169000
},
{
"id": 209,
"orgId": 100458,
"name": "CF1A112",
"description": "CF1A112",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75086856,
"createdOn": 1706846408000,
"lastUpdatedBy": 75086856,
"lastUpdatedOn": 1706846408000
}
]