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

# List deal AI fields

> List the deal AI fields of the workspace, sorted by title. Archived fields are excluded unless `includeArchived` is set. The endpoint is not paginated as the number of AI fields per workspace is capped.

Lists the deal AI fields of the workspace, sorted by title. Archived fields are excluded unless `includeArchived` is set. The endpoint is not paginated as the number of AI fields per workspace is capped.


## OpenAPI

````yaml GET /v1/deals/fields
openapi: 3.1.0
info:
  title: Claap API
  description: Development documentation
  version: 0.0.0
servers:
  - url: https://api.claap.io/
security:
  - ApiKey: []
paths:
  /v1/deals/fields:
    get:
      description: >-
        List the deal AI fields of the workspace, sorted by title. Archived
        fields are excluded unless `includeArchived` is set. The endpoint is not
        paginated as the number of AI fields per workspace is capped.
      operationId: getV1DealsAiFields
      parameters:
        - in: query
          name: includeArchived
          schema:
            type: string
            enum:
              - 'true'
              - '1'
              - 'false'
              - '0'
            default: 'false'
            description: If set to true, include archived AI fields in the results.
      responses:
        '200':
          description: Deal AI fields were successfully listed
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/AiField'
                required:
                  - result
              example:
                result:
                  - fieldId: DealAiSection#Nb4Hj7Ky2Fs9Lm1Qd6Vp3
                    title: Confirmed budget
                    kind: Field
                    outputType: Checkbox
                    prompt: Has the prospect confirmed a budget for this deal?
                    authorId: Xk2Rd7Mv4Bn9Ts1Lq6Wf3
                    createdAt: '2026-05-14T09:30:00Z'
                  - fieldId: DealAiSection#Mv6Zq1Xs8Dg3Pk5Wr9Tc2
                    title: Deal health
                    kind: Field
                    outputType: Rating
                    prompt: >-
                      Rate how likely this deal is to close, based on the
                      engagement of the prospect.
                    ratingScale: 5
                    crmField:
                      entity: Deal
                      label: Deal health
                      name: deal_health
                      source: Hubspot
                      type: Numeric
                    authorId: Xk2Rd7Mv4Bn9Ts1Lq6Wf3
                    createdAt: '2026-05-14T09:30:00Z'
components:
  schemas:
    AiField:
      type: object
      properties:
        fieldId:
          type: string
          description: >-
            AI field identifier. Matches the `fieldId` of `AiSection` view
            columns.
        title:
          type: string
          description: The field title.
        kind:
          type: string
          enum:
            - Field
            - Global
            - View
          description: >-
            The kind of AI section. Fields managed through the API are always of
            kind `Field`.
        outputType:
          type: string
          enum:
            - ActionList
            - Checkbox
            - Date
            - List
            - MultiSelect
            - Numeric
            - Paragraph
            - Rating
            - RichText
            - Select
          description: The type of value produced by the AI.
        prompt:
          type: string
          description: Instructions describing what the AI should extract.
        coloredSelectOptions:
          type: array
          items:
            $ref: '#/components/schemas/AiFieldSelectOption'
          description: >-
            The options the AI can choose from. Only set for the `Select` and
            `MultiSelect` output types.
        hasTimecodes:
          type: boolean
          description: >-
            Whether list items are linked to the moment of the recording they
            were extracted from. Only set for the `List` output type.
        ratingScale:
          type: integer
          description: The maximum rating. Only set for the `Rating` output type.
        crmField:
          $ref: '#/components/schemas/AiFieldCrmField'
          description: >-
            The CRM property the field is mapped to. Never set for company AI
            fields.
        authorId:
          type: string
          description: Identifier of the user who created the field.
        archivedAt:
          type: string
          format: date-time
          description: When the field was archived. Only set on archived fields.
        createdAt:
          type: string
          format: date-time
          description: When the field was created.
      required:
        - fieldId
        - title
        - kind
        - outputType
        - prompt
        - createdAt
      description: >-
        An AI field: a custom prompt with a typed output, evaluated by AI.
        Usable as an `AiSection` view column through its `fieldId`.
    AiFieldSelectOption:
      type: object
      properties:
        value:
          type: string
          description: The option label, as chosen by the AI and displayed in Claap.
        color:
          type: string
          enum:
            - blue
            - green
            - yellow
            - purple
            - red
            - bordeaux
            - turquoise
          description: The option color in the Claap interface.
      required:
        - value
        - color
      description: An option of a `Select` or `MultiSelect` AI field.
    AiFieldCrmField:
      type: object
      properties:
        entity:
          type: string
          enum:
            - Call
            - Company
            - Contact
            - Deal
            - Lead
            - Meeting
          description: The CRM entity the property belongs to.
        label:
          type: string
          description: The CRM property label.
        name:
          type: string
          description: The CRM property name.
        source:
          type: string
          enum:
            - Attio
            - Hubspot
            - Pipedrive
            - Salesforce
          description: The CRM the property comes from.
        type:
          type: string
          enum:
            - Checkbox
            - Date
            - MultiSelect
            - Numeric
            - RichText
            - Select
            - Text
          description: The CRM property type.
      required:
        - entity
        - label
        - name
        - source
        - type
      description: The CRM property the AI field is mapped to.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Claap-Key

````