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

# List Report Fields

> What a report on this entity can filter, group, measure and show.

The fields a report query can filter, group (`view_by` / `segment_by`), measure and show as columns, with each field's operators and fixed values, plus the period presets and date intervals. Requires a CRM read [scope](https://docs.anycrm.anyreach.ai/authentication.md#scopes).


## OpenAPI

````yaml GET /reports/fields
openapi: 3.1.0
info:
  title: anycrm-api
  version: 0.0.1
servers: []
security: []
tags:
  - name: Customer Intelligence
    description: >-
      Company research and ICP-fit scoring — create a research run, track its
      progress, and read back scored companies as leads.
  - name: Outreach
    description: >-
      The cold-email sending infrastructure — domains and mailboxes, over
      Primeforge and Warmforge.
  - name: AnyCard
    description: >-
      Authenticated CRUD for AnyCard, the org's digital business-card /
      lead-capture product.
  - name: AnyCard Events
    description: >-
      Event-attribution analytics for AnyCard — which captured leads converted,
      broken down by source, owner, and deal.
  - name: AnyCard Share Links
    description: >-
      Unauthenticated endpoints reached by anyone who scans a QR code or opens a
      shared AnyCard link.
  - name: AI
    description: >-
      A streaming (SSE) AI chat endpoint with account-commit actions it can take
      on the caller's behalf, and the job that fills every deal and account tab
      of an org.
  - name: Analytics Assistant
    description: >-
      The natural-language analytics assistant — a guarded text-to-SQL loop
      (SSE) that answers ad-hoc questions over the org's CRM data as a
      least-privilege, read-only database role.
  - name: Account Readiness
    description: >-
      Account Readiness Profiles — AI-scored signals on whether an account is
      ready for outreach or expansion, computed via a Temporal workflow.
  - name: Integrations
    description: >-
      Pipedream Connect — issuing connect tokens and managing the org's
      connected third-party accounts.
  - name: Feedback
    description: >-
      User-submitted platform feedback (bug reports, feature requests) — global,
      not scoped to one organization.
  - name: Public Media
    description: >-
      Unauthenticated image reads for publicly-embeddable assets (card photos,
      inline email images) — allowlisted by key shape; everything else in the
      storage bucket stays private.
  - name: Service Health
    description: Service liveness.
paths:
  /reports/fields:
    get:
      tags:
        - Reports
      summary: Report Fields
      description: What a report on this entity can filter, group, measure and show.
      operationId: report_fields_reports_fields_get
      parameters:
        - name: entity
          in: query
          required: false
          schema:
            enum:
              - activities
              - deals
              - stage_changes
              - contacts
              - outreach
            type: string
            default: activities
            title: Entity
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportFieldsOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ReportFieldsOut:
      properties:
        entity:
          type: string
          title: Entity
        label:
          type: string
          title: Label
        noun:
          type: string
          title: Noun
          description: One record, e.g. "deal".
        fields:
          items:
            $ref: '#/components/schemas/ReportFieldOut'
          type: array
          title: Fields
        periods:
          items:
            $ref: '#/components/schemas/FieldOption'
          type: array
          title: Periods
        intervals:
          items:
            type: string
            enum:
              - day
              - week
              - month
              - quarter
              - year
          type: array
          title: Intervals
      type: object
      required:
        - entity
        - label
        - noun
        - fields
        - periods
        - intervals
      title: ReportFieldsOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ReportFieldOut:
      properties:
        key:
          type: string
          title: Key
        label:
          type: string
          title: Label
        type:
          type: string
          enum:
            - text
            - enum
            - user
            - ref
            - number
            - date
            - boolean
          title: Type
        ops:
          items:
            type: string
          type: array
          title: Ops
        options:
          items:
            $ref: '#/components/schemas/FieldOption'
          type: array
          title: Options
          description: Fixed values (enum fields).
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: >-
            Where ref values come from: accounts, deals, contacts, stages,
            campaigns.
        groupable:
          type: boolean
          title: Groupable
        measurable:
          type: boolean
          title: Measurable
        funnel:
          type: boolean
          title: Funnel
          description: Viewing by it can be drawn as a funnel.
          default: false
        aggs:
          items:
            type: string
            enum:
              - sum
              - avg
              - count_distinct
          type: array
          title: Aggs
          description: How the field can be measured.
        unit:
          anyOf:
            - type: string
              enum:
                - money
                - percent
                - days
            - type: 'null'
          title: Unit
          description: 'How measured values read: $, % or days.'
      type: object
      required:
        - key
        - label
        - type
        - ops
        - options
        - groupable
        - measurable
      title: ReportFieldOut
    FieldOption:
      properties:
        value:
          type: string
          title: Value
        label:
          type: string
          title: Label
      type: object
      required:
        - value
        - label
      title: FieldOption
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

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