Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Custom Fields

Retrieves all the custom fields created for the org.

get/organization/customFields

Query parameters

scope'loyalty_registration loyalty_transaction' | 'customer_feedback' | 'customer_preferences' | 'store_custom_fields' | 'points_redemption' | 'voucher_redemption' | 'check_in_feedback' | 'customer_card'

Get custom fields of a specific type.

includeDisabledboolean

Whether to show custom fields that are disabled or inactive for the org.

includeDisabledAtServerboolean

Response

200

Example response

{
  "data": [
    {
      "name": "age_group",
      "type": "text",
      "dataType": "String",
      "label": "Age Group",
      "scope": "loyalty_registration",
      "phase": "1"
    }
  ]
}