---
title: "List custom field definitions"
method: GET
path: "/v1/workspaces/{workspaceUuid}/custom-fields"
tags: ["Custom Fields"]
---

# List custom field definitions

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

## Path parameters

- `workspaceUuid` string, uuid, required

## Response `200`

A list of custom field definitions

- object
  - `success` boolean
  - `data` CustomField[]
    - `identifier` string — The unique identifier of the field
    - `key` string — The machine-readable key of the field
    - `name` string — The human-readable name of the field
    - `entity_type` string — The entity type the field belongs to
    - `type` string — The data type of the field
    - `description` string, nullable
    - `group` string — The group the field belongs to
    - `is_visible` boolean
    - `source` string — The source of the field
    - `rules` object[]
    - `is_system` boolean
    - `options` object[]

---

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