---
title: "GET /workspace/{workspaceId}/custom_fields"
method: GET
path: "/workspace/{workspaceId}/custom_fields"
tags: ["Workspaces"]
---

# GET /workspace/{workspaceId}/custom_fields

`GET /workspace/{workspaceId}/custom_fields`

Get the list of all workspace custom fields and their metadata

## Path parameters

- `workspaceId` string, required

## Query parameters

- `includeOptions` boolean

## Response `200`

A list of workspace custom fields and their metadata

- CustomField[]
  - `id` string, required
  - `name` string, required
  - `type` string, required
  - `categoryId` string, nullable
  - `categoryName` string, nullable
  - `values` string[]
  - `options` CustomFieldOption[]
    - `id` string, required
    - `label` string, required
    - `startDate` string, nullable
    - `endDate` string, nullable
  - `optionShape` 'select' | 'date' | 'date_range'
  - `multi` boolean
  - `source` 'portal' | 'workspace'

## Other responses

- `400` — Invalid account ID
- `401` — No access to account
- `403` — Access denied
- `500` — An error occurred while fetching custom fields

---

[API](https://skmtc.net/craft/apis/craft-io-public-api.md) · [All operations](https://skmtc.net/craft/apis/craft-io-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/craft/craft-io-public-api/versions/2d001661c781/schema)