---
title: "Get Custom Fields"
method: GET
path: "/organization/customFields"
---

# Get Custom Fields

`GET /organization/customFields`

Retrieves all the custom fields created for the org.

## Query parameters

- `scope` 'loyalty_registration loyalty_transaction' | 'customer_feedback' | 'customer_preferences' | 'store_custom_fields' | 'points_redemption' | 'voucher_redemption' | 'check_in_feedback' | 'customer_card'
- `includeDisabled` boolean
- `includeDisabledAtServer` boolean

## Response `200`

200

- object
  - `data` object[]
    - `name` string
    - `type` string
    - `dataType` string
    - `label` string
    - `scope` string
    - `defaultValue` string
    - `phase` string
    - `position` integer
    - `rule` string
    - `serverRule` string
    - `regex` string
    - `error` string
    - `options` string
    - `isDisabled` integer
    - `isCompulsory` integer
    - `disableAtServer` integer
    - `isUpdatable` integer
    - `enableAuditTrail` integer
    - `isPiiData` integer
    - `isPsiData` integer
  - `warnings` unknown[]
    - unknown
  - `errors` unknown[]
    - unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)