> ## 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 Case Filter Fields

> List filterable workspace fields with authoritative operators and limits.



## OpenAPI

````yaml https://platform.tracecat.com/api/openapi.json get /workspaces/{workspace_id}/cases/search/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}/cases/search/fields:
    get:
      tags:
        - cases
      summary: List Case Filter Fields
      description: >-
        List filterable workspace fields with authoritative operators and
        limits.
      operationId: cases-list_case_filter_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:
                $ref: '#/components/schemas/CaseFilterMetadata'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyCookie: []
        - ServiceAccountApiKeyBearer: []
components:
  schemas:
    CaseFilterMetadata:
      properties:
        fields:
          items:
            $ref: '#/components/schemas/CaseFilterField'
          type: array
          title: Fields
        max_depth:
          type: integer
          title: Max Depth
          default: 4
        max_conditions:
          type: integer
          title: Max Conditions
          default: 50
        max_values:
          type: integer
          title: Max Values
          default: 1000
      type: object
      required:
        - fields
      title: CaseFilterMetadata
      description: Discoverable filter fields and shared query limits.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CaseFilterField:
      properties:
        field:
          type: string
          title: Field
        label:
          type: string
          title: Label
        kind:
          $ref: '#/components/schemas/FieldKind'
        operators:
          items:
            $ref: '#/components/schemas/FilterOp'
          type: array
          title: Operators
        choices:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Choices
        range_choices:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Range Choices
        input_type:
          type: string
          enum:
            - text
            - number
            - date
            - datetime-local
          title: Input Type
          default: text
      type: object
      required:
        - field
        - label
        - kind
        - operators
      title: CaseFilterField
      description: Server-defined operators and input metadata for one searchable field.
    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
    FieldKind:
      type: string
      enum:
        - text
        - number
        - boolean
        - temporal
        - enum
        - uuid
        - tag
        - json_scalar
      title: FieldKind
      description: Value families understood by the shared filter compiler.
    FilterOp:
      type: string
      enum:
        - eq
        - ne
        - in
        - not_in
        - gt
        - gte
        - lt
        - lte
        - contains
        - starts_with
        - is_null
      title: FilterOp
      description: Operations supported by the shared filter language.
  securitySchemes:
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: fastapiusersauth
    ServiceAccountApiKeyBearer:
      type: http
      description: Tracecat service account API key.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.