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

# Retrieve a list of Custom Fields

`GET /v2/customfields`

Retrieves a paginated list of Custom Fields, 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.

- ResponseCustomFieldsV2Dto
  - `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` ResponseCustomFieldV2Dto[] — The list of custom fields.
    - `id` string — The ID of the custom field (prefix `CF-`).
    - `entityType` 'JOB' | 'CLIENT' — The entity type of the custom field.
    - `name` string — The name of the custom field.
    - `type` 'Text' | 'Number' | 'Date' | 'Drop Down' | 'Checkbox' | 'Large Text' | 'File Upload' — The type of the custom field.
    - `groupId` union — The ID of the custom fields group the field belongs to (prefix `CFG-`). -1 if no group is assigned.
      - string
      - number
    - `jobTypes` ResponseGenericJobTypeV2Dto[] — The job types associated with the custom field.
      - `id` string — The ID of the job type (prefix `JT-`).
      - `name` string — The name of the job type.
    - `options` string[] — The options of the custom field.
    - `position` number — The position of the custom field.
    - `required` boolean — Indicates whether the custom field is required or not. (job only)
    - `requiredClose` boolean — Indicates whether the custom field is required to close the job. (job only)
    - `searchable` boolean — Indicates whether the custom field is searchable or not.

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