---
title: "Retrieve a list of Custom Fields Groups"
method: GET
path: "/v2/customfieldsgroups"
tags: ["Custom Fields Groups"]
---

# Retrieve a list of Custom Fields Groups

`GET /v2/customfieldsgroups`

Retrieves a paginated list of Custom Fields Groups, optionally filtered by entity type.

## Query parameters

- `pageSize` number
- `page` number
- `entityType` 'JOB' | 'CLIENT'

## Headers

- `Authorization` string, required

## Response `200`

A paginated list of Custom Fields Groups.

- ResponseCustomFieldsGroupsV2Dto
  - `pageSize` number — The maximum number of items returned per page.
  - `page` number — The current page number.
  - `totalResults` number — The total number of results.
  - `hasMore` boolean — Whether there are more results.
  - `data` ResponseCustomFieldsGroupV2Dto[] — The list of custom fields groups.
    - `id` string — The ID of the custom fields group (prefix `CFG-`).
    - `entityType` 'JOB' | 'CLIENT' — The entity type of the custom fields group.
    - `name` string — The name of the custom fields group.

## Other responses

- `400` — Invalid query parameters.
- `401` — Missing or invalid authentication token.

---

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