Developer Documentation

Get all custom fields

get https://{host}/api_gateway/rewards/core/v1/brand/customfield

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

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URI/api_gateway/rewards/core/v1/brand/customfield
HTTP MethodGET
PaginationNo
Batch supportNo
Rate limit informationNone

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/brand/customfield

Request Query Parameters

Parameter NameData TypeDescription
scopeStringScope 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 NameData TypeDescription
idIntegerUnique identifier for the custom field.
orgIdIntegerUnique identifier of the organisation.
nameStringUnique name for the custom field.
descriptionStringDescription of the custom field.
isMandatoryBooleanIndicates if the custom field is mandatory. Possible values:
true: Field is mandatory
false: Field is optional (default value)
isActiveBooleanIndicates the status of the custom field. Possible values:
true: Status is active (default value)
false: Status is inactive.
scopeStringIndicates 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.
defaultValueNullDefault value for the custom field used when no value is specified.
dataTypeStringType of data for the custom field. Possible values:
BOOLEAN, ENUM, DATE, STRING, INTEGER.
createdByIntegerUnique customer identifier of the user who created the custom field
createdOnLongCreation date and time of the field.
lastUpdatedByIntegerUnique customer identifier of the user who last updated the custom field
lastUpdatedOnLongLast update date and time of the field.
enumValuesObjectObject containing the enum values.
[
    {
        "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": 15042,
        "orgId": 100458,
        "name": "CustomField2",
        "description": "",
        "isMandatory": false,
        "isActive": true,
        "scope": "ISSUE_REWARD",
        "defaultValue": "PRIMARY",
        "dataType": "ENUM",
        "createdBy": 50716508,
        "createdOn": 1740044396000,
        "lastUpdatedBy": 50716508,
        "lastUpdatedOn": 1740044396000,
        "enumValues": [
            "PRIMARY",
            "SECONDARY"
        ]
    }
]

[
    {
        "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
    }
]

[
    {
        "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": 5919,
        "orgId": 100458,
        "name": "testdate",
        "description": "order id of reward purchased",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "DATE",
        "createdBy": 75078478,
        "createdOn": 1720003554000,
        "lastUpdatedBy": 75078478,
        "lastUpdatedOn": 1720003554000
    },
    {
        "id": 5920,
        "orgId": 100458,
        "name": "testdate1",
        "description": "order id of reward purchased",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "DATE",
        "createdBy": 75078478,
        "createdOn": 1720003572000,
        "lastUpdatedBy": 75078478,
        "lastUpdatedOn": 1720003572000
    },
    {
        "id": 5921,
        "orgId": 100458,
        "name": "testdate2",
        "description": "order id of reward purchased",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "2024-06-07 12:12:00",
        "dataType": "DATE",
        "createdBy": 75078478,
        "createdOn": 1720003672000,
        "lastUpdatedBy": 75078478,
        "lastUpdatedOn": 1720003672000
    },
    {
        "id": 6006,
        "orgId": 100458,
        "name": "te6",
        "description": "te6 Description",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "True",
        "dataType": "BOOLEAN",
        "createdBy": 75036445,
        "createdOn": 1720148863000,
        "lastUpdatedBy": 75036445,
        "lastUpdatedOn": 1720148863000
    },
    {
        "id": 6017,
        "orgId": 100458,
        "name": "CF17",
        "description": "CF17 Description",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "CF17",
        "dataType": "STRING",
        "createdBy": 75036445,
        "createdOn": 1720168148000,
        "lastUpdatedBy": 75036445,
        "lastUpdatedOn": 1720168148000
    },
    {
        "id": 6021,
        "orgId": 100458,
        "name": "CF77",
        "description": "CF77 Description",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "true",
        "dataType": "BOOLEAN",
        "createdBy": 75036445,
        "createdOn": 1720168829000,
        "lastUpdatedBy": 75036445,
        "lastUpdatedOn": 1720168829000
    },
    {
        "id": 6025,
        "orgId": 100458,
        "name": "CF9009",
        "description": "CF9009 Description",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": "true",
        "dataType": "BOOLEAN",
        "createdBy": null,
        "createdOn": 1720169130000,
        "lastUpdatedBy": 75036445,
        "lastUpdatedOn": 1720171725000
    },
    {
        "id": 6611,
        "orgId": 100458,
        "name": "labelsV1",
        "description": "labelsV1 Description",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75036445,
        "createdOn": 1721196012000,
        "lastUpdatedBy": 75036445,
        "lastUpdatedOn": 1721196012000
    },
    {
        "id": 6914,
        "orgId": 100458,
        "name": "Order confirmed",
        "description": "Reward is processing",
        "isMandatory": false,
        "isActive": true,
        "scope": "REWARD",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75130850,
        "createdOn": 1721739118000,
        "lastUpdatedBy": 75130850,
        "lastUpdatedOn": 1721739118000
    }
]

[
    {
        "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": 6220,
        "orgId": 100458,
        "name": "Scope_Reward",
        "description": "Scope_Reward Description",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": "",
        "dataType": "STRING",
        "createdBy": 75036445,
        "createdOn": 1720513051000,
        "lastUpdatedBy": 75036445,
        "lastUpdatedOn": 1720513051000
    },
    {
        "id": 6913,
        "orgId": 100458,
        "name": "Order confirmed",
        "description": "Reward is processing",
        "isMandatory": false,
        "isActive": true,
        "scope": "CATALOGUE_PROMOTION",
        "defaultValue": null,
        "dataType": "STRING",
        "createdBy": 75130850,
        "createdOn": 1721739035000,
        "lastUpdatedBy": 75130850,
        "lastUpdatedOn": 1721739035000
    }
]
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!