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
- Authentication: Basic or OAuth 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
Request Query Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| scope | String | The scope 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. |
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 | The scope 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. |
| 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. NOTE: The custom field creation time should be in UTC format. |
| lastUpdatedBy | Integer | User identifier who last updated the field. |
| lastUpdatedOn | Long | Last update date and time of the field. |
[
{
"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": 5916,
"orgId": 100458,
"name": "CF1",
"description": "CF1 Description",
"isMandatory": false,
"isActive": true,
"scope": "REWARD",
"defaultValue": "test",
"dataType": "STRING",
"createdBy": 75036445,
"createdOn": 1720003372000,
"lastUpdatedBy": 75036445,
"lastUpdatedOn": 1720003372000
},
{
"id": 5918,
"orgId": 100458,
"name": "testdate",
"description": "order id of reward purchased",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": null,
"dataType": "DATE",
"createdBy": 75078478,
"createdOn": 1720003550000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1720003550000
}
]
[
{
"id": 5918,
"orgId": 100458,
"name": "testdate",
"description": "order id of reward purchased",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": null,
"dataType": "DATE",
"createdBy": 75078478,
"createdOn": 1720003550000,
"lastUpdatedBy": 75078478,
"lastUpdatedOn": 1720003550000
},
{
"id": 6215,
"orgId": 100458,
"name": "CF_Scope",
"description": "CF_Scope Description",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": "1",
"dataType": "INTEGER",
"createdBy": 75036445,
"createdOn": 1720510462000,
"lastUpdatedBy": 75036445,
"lastUpdatedOn": 1720510462000
},
{
"id": 6219,
"orgId": 100458,
"name": "Custom_Scope_7",
"description": "Custom_Scope_7 Description",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": "false",
"dataType": "BOOLEAN",
"createdBy": 75036445,
"createdOn": 1720512990000,
"lastUpdatedBy": 75036445,
"lastUpdatedOn": 1720512990000
},
{
"id": 6854,
"orgId": 100458,
"name": "ON ITS WAY",
"description": "OIW",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75130850,
"createdOn": 1721649424000,
"lastUpdatedBy": 75130850,
"lastUpdatedOn": 1721649424000
},
{
"id": 6861,
"orgId": 100458,
"name": "On the way",
"description": "OIW",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75130850,
"createdOn": 1721653084000,
"lastUpdatedBy": 75130850,
"lastUpdatedOn": 1721653084000
},
{
"id": 6862,
"orgId": 100458,
"name": "On the wayy",
"description": "On the way_1",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75130850,
"createdOn": 1721653217000,
"lastUpdatedBy": 75130850,
"lastUpdatedOn": 1721653217000
},
{
"id": 6863,
"orgId": 100458,
"name": "DELIVERING SOON",
"description": "DELIVERING SOON",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75130850,
"createdOn": 1721653407000,
"lastUpdatedBy": 75130850,
"lastUpdatedOn": 1721653407000
},
{
"id": 6866,
"orgId": 100458,
"name": "DELIVERING SOOON",
"description": "DELIVERING SOON",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75130850,
"createdOn": 1721653589000,
"lastUpdatedBy": 75130850,
"lastUpdatedOn": 1721653589000
},
{
"id": 6867,
"orgId": 100458,
"name": "In Transit",
"description": "Reward is processing",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75130850,
"createdOn": 1721653883000,
"lastUpdatedBy": 75130850,
"lastUpdatedOn": 1721653883000
},
{
"id": 6868,
"orgId": 100458,
"name": "Order confirmed",
"description": "Reward is processing",
"isMandatory": false,
"isActive": true,
"scope": "ISSUE_REWARD",
"defaultValue": null,
"dataType": "STRING",
"createdBy": 75130850,
"createdOn": 1721654265000,
"lastUpdatedBy": 75130850,
"lastUpdatedOn": 1721654265000
}
]