---
title: "List workspace card field definitions (viewer+); ?template_id=N filters by template"
method: GET
path: "/api/workspaces/{workspace_id}/card-fields"
tags: ["card-fields"]
---

# List workspace card field definitions (viewer+); ?template_id=N filters by template

`GET /api/workspaces/{workspace_id}/card-fields`

## Request

- Base URL: `https://api.hillstar.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.hillstar.ai/api/workspaces/{workspace_id}/card-fields`
- Auth: none declared

## Path parameters

- `workspace_id` integer, required: Workspace ID

## Query parameters

- `template_id` integer: Filter by template ID (omit or 0 = no filter)

## Response `200`

OK

- CardFieldRead[], nullable
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `created_at` string, date-time, required
  - `description` string, nullable, required
  - `enum_config` object, required
  - `field_enums` string[], required
  - `field_key` string, nullable, required
  - `field_type` 'text' | 'select' | 'multi_select' | 'number' | 'boolean' | 'date' | 'vote', required: Data type for a card field (EAV).
  - `id` integer, required
  - `is_active` boolean, required
  - `is_required` boolean, required
  - `label` string, required
  - `sort_order` integer, required
  - `template_id` integer, nullable, required
  - `updated_at` string, date-time, required
  - `workspace_id` integer, required

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/hillstar/apis/rfpai-api-go.md) - [All operations](https://skmtc.dev/hillstar/apis/rfpai-api-go/llms.txt) - [OpenAPI document](https://skmtc.dev/hillstar/apis/rfpai-api-go/revisions/b2532dc47fc6?raw)