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

# The tenant's field definitions, with how many records have answered each (UI spec §34).



## OpenAPI

````yaml /api-reference/openapi.json get /custom_field_settings
openapi: 3.0.0
info:
  description: ''
  title: >-
    The only schema PostgREST exposes (ADR-014). Reads are security_invoker
    views; writes are SECURITY DEFINER functions. Rebuilt wholesale on every
    deploy — it holds no data.
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - name: Signing in
  - name: Profile
  - name: Assets
  - name: Asset lifecycle
  - name: Work lifecycle
  - name: Maintenance
  - name: Inventory
  - name: Inventory detail
  - name: Procurement
  - name: Contracts
  - name: Workforce
  - name: Capacity
  - name: Dispatch
  - name: Routing
  - name: Tools
  - name: Inspections
  - name: Verification
  - name: Reliability
  - name: Parts demand
  - name: Sensors and meters
  - name: Map
  - name: Floor plans
  - name: Labels
  - name: Lost and found
  - name: Root cause analysis
  - name: Reports
  - name: Audit center
  - name: Activity
  - name: Notifications
  - name: Channels
  - name: Search
  - name: Copilot
  - name: Import
  - name: Files
  - name: Sync
  - name: Support
  - name: Admin
  - name: Access
  - name: Lookups
  - name: Read models
  - name: Branding
  - name: Custom fields
  - name: Form studio
  - name: Workflows
  - name: Workflow studio
  - name: Rules
  - name: Statuses and transitions
  - name: Currencies and locales
  - name: Work configuration
  - name: Asset configuration
  - name: Inventory configuration
  - name: Tool configuration
  - name: Workforce configuration
  - name: Vendor and contract configuration
  - name: Document configuration
  - name: Inspection configuration
  - name: Sites, locations and the organisation
  - name: Platform
  - name: Self verification
  - name: Setup
  - name: Tools on a job, and who has them out
  - name: Vendors and contracts
  - name: Work order execution
  - name: Workforce detail
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /custom_field_settings:
    get:
      tags:
        - Custom fields
      summary: >-
        The tenant's field definitions, with how many records have answered each
        (UI spec §34).
      parameters:
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.id'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.entity_type'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.entity_label'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.field_key'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.name'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.description'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.help_text'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.placeholder'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.data_type'
        - $ref: >-
            #/components/parameters/rowFilter.custom_field_settings.reference_entity_type
        - $ref: >-
            #/components/parameters/rowFilter.custom_field_settings.custom_field_group_id
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.group_code'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.group_name'
        - $ref: >-
            #/components/parameters/rowFilter.custom_field_settings.display_order
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.status'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.is_required'
        - $ref: >-
            #/components/parameters/rowFilter.custom_field_settings.is_searchable
        - $ref: >-
            #/components/parameters/rowFilter.custom_field_settings.is_filterable
        - $ref: >-
            #/components/parameters/rowFilter.custom_field_settings.offline_available
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.retired_at'
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.row_version'
        - $ref: >-
            #/components/parameters/rowFilter.custom_field_settings.live_version_id
        - $ref: >-
            #/components/parameters/rowFilter.custom_field_settings.draft_version_id
        - $ref: >-
            #/components/parameters/rowFilter.custom_field_settings.version_number
        - $ref: '#/components/parameters/rowFilter.custom_field_settings.answers'
        - $ref: '#/components/parameters/select'
        - $ref: '#/components/parameters/order'
        - $ref: '#/components/parameters/range'
        - $ref: '#/components/parameters/rangeUnit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/preferCount'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/custom_field_settings'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/custom_field_settings'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/custom_field_settings'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/custom_field_settings'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.custom_field_settings.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.entity_type:
      in: query
      name: entity_type
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.entity_label:
      in: query
      name: entity_label
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.field_key:
      in: query
      name: field_key
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.description:
      in: query
      name: description
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.help_text:
      in: query
      name: help_text
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.placeholder:
      in: query
      name: placeholder
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.data_type:
      in: query
      name: data_type
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.reference_entity_type:
      in: query
      name: reference_entity_type
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.custom_field_group_id:
      in: query
      name: custom_field_group_id
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.group_code:
      in: query
      name: group_code
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.group_name:
      in: query
      name: group_name
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.display_order:
      in: query
      name: display_order
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.status:
      in: query
      name: status
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.is_required:
      in: query
      name: is_required
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.is_searchable:
      in: query
      name: is_searchable
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.is_filterable:
      in: query
      name: is_filterable
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.offline_available:
      in: query
      name: offline_available
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.retired_at:
      in: query
      name: retired_at
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.row_version:
      in: query
      name: row_version
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.live_version_id:
      in: query
      name: live_version_id
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.draft_version_id:
      in: query
      name: draft_version_id
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.version_number:
      in: query
      name: version_number
      required: false
      schema:
        type: string
    rowFilter.custom_field_settings.answers:
      in: query
      name: answers
      required: false
      schema:
        type: string
    select:
      description: Filtering Columns
      in: query
      name: select
      required: false
      schema:
        type: string
    order:
      description: Ordering
      in: query
      name: order
      required: false
      schema:
        type: string
    range:
      description: Limiting and Pagination
      in: header
      name: Range
      required: false
      schema:
        type: string
    rangeUnit:
      description: Limiting and Pagination
      in: header
      name: Range-Unit
      required: false
      schema:
        default: items
        type: string
    offset:
      description: Limiting and Pagination
      in: query
      name: offset
      required: false
      schema:
        type: string
    limit:
      description: Limiting and Pagination
      in: query
      name: limit
      required: false
      schema:
        type: string
    preferCount:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - count=none
        type: string
  schemas:
    custom_field_settings:
      description: >-
        The tenant's field definitions, with how many records have answered each
        (UI spec §34).
      properties:
        answers:
          format: bigint
          type: integer
        custom_field_group_id:
          format: uuid
          type: string
        data_type:
          format: character varying
          maxLength: 20
          type: string
        description:
          format: text
          type: string
        display_order:
          format: integer
          type: integer
        draft_version_id:
          format: uuid
          type: string
        entity_label:
          format: character varying
          maxLength: 120
          type: string
        entity_type:
          description: >-
            Note:

            This is a Foreign Key to `custom_field_scopes.entity`.<fk
            table='custom_field_scopes' column='entity'/>
          format: character varying
          maxLength: 80
          type: string
        field_key:
          format: character varying
          maxLength: 80
          type: string
        group_code:
          format: character varying
          maxLength: 60
          type: string
        group_name:
          format: character varying
          maxLength: 150
          type: string
        help_text:
          format: text
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_filterable:
          format: boolean
          type: boolean
        is_required:
          format: boolean
          type: boolean
        is_searchable:
          format: boolean
          type: boolean
        live_version_id:
          format: uuid
          type: string
        name:
          format: character varying
          maxLength: 150
          type: string
        offline_available:
          format: boolean
          type: boolean
        placeholder:
          format: character varying
          maxLength: 200
          type: string
        reference_entity_type:
          description: >-
            Note:

            This is a Foreign Key to `custom_field_scopes.entity`.<fk
            table='custom_field_scopes' column='entity'/>
          format: character varying
          maxLength: 80
          type: string
        retired_at:
          format: timestamp with time zone
          type: string
        row_version:
          format: bigint
          type: integer
        status:
          format: character varying
          maxLength: 20
          type: string
        version_number:
          format: integer
          type: integer
      type: object

````

## Related topics

- [Reports](/analytics/reports.md)
- [Copilot activity](/analytics/copilot.md)
- [Custom fields](/config/custom-fields.md)
- [Currency and exchange rates](/config/currency.md)
- [The work order list](/work/work-orders.md)