---
title: "List workspace custom fields"
method: GET
path: "/workspace/{workspace_id}/custom-fields"
tags: ["Custom Fields"]
---

# List workspace custom fields

`GET /workspace/{workspace_id}/custom-fields`

Get all custom field definitions for a workspace

## Path parameters

- `workspace_id` string, uuid, required

## Response `200`

Custom fields retrieved successfully

- CustomFieldListResponse — List of custom fields
  - `custom_fields` WorkspaceCustomField[], required
    - `id` string, uuid, required — Unique identifier
    - `field_name` string, required — Machine-readable field name (auto-generated from label)
    - `field_label` string, required — Human-readable display label
    - `is_preset` boolean — If true, this field has a preset value for all users
    - `preset_value` string, nullable — Preset value (only used when is_preset=true)
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `401` — Unauthorized - Invalid or missing API key
- `404` — Not Found - Resource does not exist

---

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