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

# Get Org Custom Fields

`GET /organization/customfields`

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

## Query parameters

- `format` 'xml' | 'json'
- `Scope` 'customer_feedback' | 'loyalty_transaction' | 'loyalty_registration' | 'customer_preferences'

## Response `200`

200

- object
  - `response` object
    - `status` object
      - `success` string
      - `code` string
      - `message` string
    - `organization` object
      - `custom_fields` object
        - `field` object
          - `name` string
          - `label` string
          - `type` string
          - `datatype` string
          - `default` string
          - `phase` string
          - `position` string
          - `rule` string
          - `regex` string
          - `error` string
          - `options` string
          - `scope` string
          - `is_mandatory` string
          - `is_disabled` string

## 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)