---
title: "Get Custom Fields"
method: GET
path: "/settings/custom_fields"
---

# Get Custom Fields

`GET /settings/custom_fields`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/settings/custom_fields`
- Auth: API key in header `x-api-key`

## Query parameters

- `module_name` 'JOB' | 'CUSTOMER' | 'EMPLOYEE' | 'ESTIMATE' | 'INVOICE' | 'PRODUCT' | 'PURCHASE_ORDER' | 'MATERIAL_REQUESTS' | 'VENDOR' | 'SERVICE_CONTRACT' | 'ASSET' | 'PROPERTY' | 'ORGANIZATION' | 'TEAM' | 'REQUEST' | 'PROJECT', required
- `include_original_template` boolean
- `sort` 'ASC' | 'DESC'
- `sort_by` 'display_order'

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `meta_options` object
      - `restrict_to_camera` boolean
      - `watermark_image` boolean
    - `_id` string
    - `custom_field_uid` string
    - `field_name` string
    - `field_type` string
    - `field_description` string
    - `field_placeholder` string
    - `field_options` string[]
    - `internal_key` string
    - `display_order` integer
    - `field_validation` unknown
    - `min_value` string
    - `max_value` string
    - `is_required` boolean
    - `hide_to_fe` boolean
    - `hide_field` boolean
    - `read_only` boolean
    - `default_option` boolean
    - `default_options` unknown[]
      - unknown
    - `is_dependent` boolean
    - `dependent_on` string
    - `dependent_options` unknown[]
      - unknown

## Other responses

- `500`: 500

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/settings/custom_fields/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)