> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Fields

> List all case fields.



## OpenAPI

````yaml https://platform.tracecat.com/api/openapi.json get /workspaces/{workspace_id}/case-fields
openapi: 3.1.0
info:
  title: Tracecat API
  summary: Tracecat API
  description: The open source AI automation platform for security teams and agents.
  termsOfService: >-
    https://docs.google.com/document/d/e/2PACX-1vQvDe3SoVAPoQc51MgfGCP71IqFYX_rMVEde8zC4qmBCec5f8PLKQRdxa6tsUABT8gWAR9J-EVs2CrQ/pub
  contact:
    name: Tracecat Founders
    email: founders@tracecat.com
  license:
    name: AGPL-3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
  version: '1'
servers:
  - url: /api
security: []
tags:
  - name: public
    description: Public facing endpoints
  - name: workflows
    description: Workflow management
  - name: actions
    description: Action management
  - name: triggers
    description: Workflow triggers
  - name: secrets
    description: Secret management
  - name: variables
    description: Workspace variable management
paths:
  /workspaces/{workspace_id}/case-fields:
    get:
      tags:
        - cases
      summary: List Fields
      description: List all case fields.
      operationId: cases-list_fields
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Workspace Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CaseFieldReadMinimal'
                title: Response Cases-List Fields
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyCookie: []
        - ServiceAccountApiKeyBearer: []
components:
  schemas:
    CaseFieldReadMinimal:
      properties:
        id:
          type: string
          title: Id
        type:
          $ref: '#/components/schemas/CaseFieldReadType'
        description:
          type: string
          title: Description
        nullable:
          type: boolean
          title: Nullable
        default:
          anyOf:
            - type: string
            - type: 'null'
          title: Default
        reserved:
          type: boolean
          title: Reserved
        options:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Options
        kind:
          anyOf:
            - $ref: '#/components/schemas/CaseFieldKind'
            - type: 'null'
        required_on_closure:
          type: boolean
          title: Required On Closure
          default: false
      type: object
      required:
        - id
        - type
        - description
        - nullable
        - default
        - reserved
      title: CaseFieldReadMinimal
      description: Minimal read model for a case field.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CaseFieldReadType:
      type: string
      enum:
        - TEXT
        - INTEGER
        - NUMERIC
        - DATE
        - BOOLEAN
        - TIMESTAMPTZ
        - JSONB
        - SELECT
        - MULTI_SELECT
        - UUID
      title: CaseFieldReadType
      description: Read-only type for case field metadata.
    CaseFieldKind:
      type: string
      enum:
        - LONG_TEXT
        - URL
      title: CaseFieldKind
      description: >-
        Semantic kind for case custom fields.


        Controls how the field is rendered in the UI without changing the
        underlying

        SQL storage type.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: fastapiusersauth
    ServiceAccountApiKeyBearer:
      type: http
      description: Tracecat service account API key.
      scheme: bearer

````