---
title: "Get Custom Field Groups"
method: GET
path: "/settings/custom_fields/group"
---

# Get Custom Field Groups

`GET /settings/custom_fields/group`

## Request

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

## Query parameters

- `sort` 'ASC' | 'DESC'
- `sort_by` 'order_no'
- `filter.keyword` string
- `filter.module_name` 'JOB' | 'CUSTOMER' | 'EMPLOYEE' | 'ESTIMATE' | 'INVOICE' | 'PRODUCT' | 'PURCHASE_ORDER' | 'SERVICE_CONTRACT' | 'ASSET' | 'PROPERTY' | 'ORGANIZATION' | 'TEAM' | 'REQUEST' | 'PROJECT', required

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `module_name` string
    - `group_name` string
    - `group_uid` string
    - `associated_to` unknown[]
      - unknown
    - `order_no` integer
    - `is_deleted` boolean
    - `created_at` string
    - `updated_at` string
    - `category` 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/group/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)