---
title: "List custom field definitions"
method: GET
path: "/workflows/custom_fields"
tags: ["Workflows"]
---

# List custom field definitions

`GET /workflows/custom_fields`

Returns the custom field definitions for a given entity type.

🔒 Requires: `custom_fields:read` scope

## Query parameters

- `entity` 'sale' | 'line_item' | 'customer' | 'product', required

## Response `200`

A list of all the custom field definitions associated with the entity type.

- CustomFieldDefinitionCollection — The fields returned by the custom fields definition list API.
  - `data` CustomFieldDefinition[], required — An array of Custom Field Definitions.
    - `created_at` string, date-time — The creation timestamp in UTC.
    - `editable_in_ui` boolean — Is this custom field be editable in the UI.
    - `entity` 'sale' | 'line_item' | 'customer' | 'product' — The type of entity.
    - `id` string
    - `name` string
    - `title` string
    - `type` 'string' | 'integer' | 'boolean' | 'date' | 'product_id' | 'qrcode' | 'string_array' — The type of the value to be stored using this custom field.
    - `visible_in_ui` boolean — Is this custom field visible in the UI.

---

[API](https://skmtc.net/lightspeedhq/apis/api-2026-07.md) · [All operations](https://skmtc.net/lightspeedhq/apis/api-2026-07/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightspeedhq/api-2026-07/revisions/72d4ceb46dbb/schema)