v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Org Custom Fields

Returns the details of custom fields configured for the current organization.

get/organization/customfields

Query parameters

format'xml' | 'json'

Preferred response format.

Scope'customer_feedback' | 'loyalty_transaction' | 'loyalty_registration' | 'customer_preferences'

Type of custom fields to retrieve. If no parameter is passed, custom fields of all modules will be returned.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": "200",
      "message": "SUCCESS"
    },
    "organization": {
      "custom_fields": {
        "field": {
          "name": "addresstwo",
          "label": "Address",
          "type": "text",
          "datatype": "String",
          "default": "[\"1\"]",
          "phase": "2",
          "position": "2",
          "scope": "loyalty_transaction",
          "is_mandatory": "0",
          "is_disabled": "0"
        }
      }
    }
  }
}