---
title: "Get custom fields on a workspace"
method: GET
path: "/v1/workspaces/{workspaceId}/custom-fields"
tags: ["Custom fields"]
---

# Get custom fields on a workspace

`GET /v1/workspaces/{workspaceId}/custom-fields`

## Path parameters

- `workspaceId` string, required — Represents a workspace identifier across the system.

## Query parameters

- `name` string — If provided, you'll get a filtered list of custom fields that contain the provided string in their name.
- `status` 'INACTIVE' | 'VISIBLE' | 'INVISIBLE'
- `entity-type` string

## Response `200`

OK

- CustomFieldDtoV1[]
  - `allowedValues` string[] — Represents a list of custom field's allowed values.
  - `description` string — Represents custom field description.
  - `entityType` string — Represents custom field entity type
  - `id` string — Represents custom field identifier across the system.
  - `name` string — Represents custom field name.
  - `onlyAdminCanEdit` boolean — Flag to set whether custom field is modifiable only by admin users.
  - `placeholder` string — Represents custom field placeholder value.
  - `projectDefaultValues` CustomFieldDefaultValuesDtoV1[] — Represents a list of custom field default values data transfer objects.
    - `projectId` string — Represents project identifier across the system.
    - `status` string — Represents custom field status
    - `value` object — Represents a custom field's default value
  - `required` boolean — Flag to set whether custom field is mandatory or not.
  - `status` string — Represents custom field status
  - `type` string — Represents custom field type.
  - `workspaceDefaultValue` object — Represents a custom field's default value in the workspace.
  - `workspaceId` string — Represents workspace identifier across the system.

---

[API](https://skmtc.dev/clockify/apis/clockify-api.md) · [All operations](https://skmtc.dev/clockify/apis/clockify-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/clockify/clockify-api/revisions/a5b636acbcd8/schema)