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

# Returns the complete collection of core and custom fields for the current tenant.



## OpenAPI

````yaml /api-reference/openapi.json get /api/field
openapi: 3.1.1
info:
  title: EKSO.API
  description: >-
    REST API for EKSO — ticketing, help desk, project management, resource
    planning, and time tracking.
  contact:
    name: Ekso
    url: https://ekso.dev
  version: v1
servers:
  - url: https://{install}
    description: Your self-hosted Ekso install
    variables:
      install:
        default: your-ekso-install.example.com
        description: Your install hostname (the PublicUrl set in /startup)
security: []
tags:
  - name: Clock
  - name: Process
  - name: Rule
  - name: Watch
  - name: User
  - name: UserGroup
  - name: Time
  - name: AppSetting
  - name: Hook
  - name: Tenant
  - name: OutboundStorage
  - name: Plan
  - name: Notification
  - name: MailGeneral
  - name: Mailbox
  - name: OutboundMail
  - name: Ticket
  - name: Link
  - name: Item
  - name: Screen
  - name: BudgetReason
  - name: CostCenter
  - name: Crm
  - name: JobRole
  - name: NonBillable
  - name: Reporting
  - name: Sku
  - name: File
  - name: Docs
  - name: Constraint
  - name: ContentTemplate
  - name: Field
  - name: Area
  - name: Container
  - name: Label
  - name: Board
  - name: Cycle
  - name: AccessControl
  - name: Config
  - name: EntraMeta
  - name: Meta
  - name: Annotation
  - name: Chat
  - name: ApiKey
paths:
  /api/field:
    get:
      tags:
        - Field
      summary: >-
        Returns the complete collection of core and custom fields for the
        current tenant.
      operationId: Field_list
      responses:
        '200':
          description: The field collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldCollection'
        '400':
          description: Validation error — field-level errors in Fields[]
        '403':
          description: Permission denied — insufficient permissions
        '422':
          description: Business rule violation — logic error
        '500':
          description: Internal server error
      security:
        - Bearer: []
components:
  schemas:
    FieldCollection:
      type: object
      properties:
        typeDate:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldDate'
        typeDecimal:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldDecimal'
        typeInteger:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldInteger'
        typeList:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldList'
        typePercent:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldPercent'
        typePicker:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldPicker'
        typeText:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldText'
        typeTime:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldTime'
        typeToggle:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldToggle'
      description: >-
        All field definitions visible to a tenant, bucketed by type. Acts as the

        lookup surface for "give me the id of the Status field" / "what's the
        data

        list on Priority" — used at item-build time (server onboarding, CLI
        apply

        layer) and at rule-evaluation time.
    DataFieldDate:
      type: object
      properties:
        entity:
          type:
            - 'null'
            - string
        fieldType:
          type:
            - 'null'
            - string
        minimum:
          type:
            - 'null'
            - string
          format: date-time
        maximum:
          type:
            - 'null'
            - string
          format: date-time
        defaultValue:
          type: string
        name:
          type: string
        prompt:
          type: string
        description:
          type: string
        isCore:
          type: boolean
        isFeature:
          type: boolean
        featureName:
          type: string
        placement:
          type: array
          items:
            $ref: '#/components/schemas/FieldPlacement'
        usage:
          type: array
          items:
            $ref: '#/components/schemas/FieldUsage'
        listEditable:
          type: boolean
        tenantId:
          type: string
        id:
          type: string
        created:
          type: string
          format: date-time
        createdBy:
          type: string
        updated:
          type: string
          format: date-time
        updatedBy:
          type: string
        deleted:
          type: boolean
    DataFieldDecimal:
      type: object
      properties:
        entity:
          type:
            - 'null'
            - string
        fieldType:
          type:
            - 'null'
            - string
        minimum:
          type: number
          format: double
        maximum:
          type: number
          format: double
        defaultValue:
          type: string
        name:
          type: string
        prompt:
          type: string
        description:
          type: string
        isCore:
          type: boolean
        isFeature:
          type: boolean
        featureName:
          type: string
        placement:
          type: array
          items:
            $ref: '#/components/schemas/FieldPlacement'
        usage:
          type: array
          items:
            $ref: '#/components/schemas/FieldUsage'
        listEditable:
          type: boolean
        tenantId:
          type: string
        id:
          type: string
        created:
          type: string
          format: date-time
        createdBy:
          type: string
        updated:
          type: string
          format: date-time
        updatedBy:
          type: string
        deleted:
          type: boolean
    DataFieldInteger:
      type: object
      properties:
        entity:
          type:
            - 'null'
            - string
        fieldType:
          type:
            - 'null'
            - string
        minimum:
          type: integer
          format: int32
        maximum:
          type: integer
          format: int32
        defaultValue:
          type: string
        name:
          type: string
        prompt:
          type: string
        description:
          type: string
        isCore:
          type: boolean
        isFeature:
          type: boolean
        featureName:
          type: string
        placement:
          type: array
          items:
            $ref: '#/components/schemas/FieldPlacement'
        usage:
          type: array
          items:
            $ref: '#/components/schemas/FieldUsage'
        listEditable:
          type: boolean
        tenantId:
          type: string
        id:
          type: string
        created:
          type: string
          format: date-time
        createdBy:
          type: string
        updated:
          type: string
          format: date-time
        updatedBy:
          type: string
        deleted:
          type: boolean
    DataFieldList:
      type: object
      properties:
        entity:
          type:
            - 'null'
            - string
        fieldType:
          type:
            - 'null'
            - string
        multiSelect:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/DataFieldListData'
        defaultValue:
          type: string
        name:
          type: string
        prompt:
          type: string
        description:
          type: string
        isCore:
          type: boolean
        isFeature:
          type: boolean
        featureName:
          type: string
        placement:
          type: array
          items:
            $ref: '#/components/schemas/FieldPlacement'
        usage:
          type: array
          items:
            $ref: '#/components/schemas/FieldUsage'
        listEditable:
          type: boolean
        tenantId:
          type: string
        id:
          type: string
        created:
          type: string
          format: date-time
        createdBy:
          type: string
        updated:
          type: string
          format: date-time
        updatedBy:
          type: string
        deleted:
          type: boolean
    DataFieldPercent:
      type: object
      properties:
        entity:
          type:
            - 'null'
            - string
        fieldType:
          type:
            - 'null'
            - string
        minimum:
          type: integer
          format: int32
        maximum:
          type: integer
          format: int32
        defaultValue:
          type: string
        name:
          type: string
        prompt:
          type: string
        description:
          type: string
        isCore:
          type: boolean
        isFeature:
          type: boolean
        featureName:
          type: string
        placement:
          type: array
          items:
            $ref: '#/components/schemas/FieldPlacement'
        usage:
          type: array
          items:
            $ref: '#/components/schemas/FieldUsage'
        listEditable:
          type: boolean
        tenantId:
          type: string
        id:
          type: string
        created:
          type: string
          format: date-time
        createdBy:
          type: string
        updated:
          type: string
          format: date-time
        updatedBy:
          type: string
        deleted:
          type: boolean
    DataFieldPicker:
      type: object
      properties:
        entity:
          type:
            - 'null'
            - string
        fieldType:
          type:
            - 'null'
            - string
        scope:
          type: string
        multiSelect:
          type: boolean
        defaultValue:
          type: string
        name:
          type: string
        prompt:
          type: string
        description:
          type: string
        isCore:
          type: boolean
        isFeature:
          type: boolean
        featureName:
          type: string
        placement:
          type: array
          items:
            $ref: '#/components/schemas/FieldPlacement'
        usage:
          type: array
          items:
            $ref: '#/components/schemas/FieldUsage'
        listEditable:
          type: boolean
        tenantId:
          type: string
        id:
          type: string
        created:
          type: string
          format: date-time
        createdBy:
          type: string
        updated:
          type: string
          format: date-time
        updatedBy:
          type: string
        deleted:
          type: boolean
    DataFieldText:
      type: object
      properties:
        entity:
          type:
            - 'null'
            - string
        fieldType:
          type:
            - 'null'
            - string
        contentType:
          type: string
        maximum:
          type: integer
          format: int32
        defaultValue:
          type: string
        name:
          type: string
        prompt:
          type: string
        description:
          type: string
        isCore:
          type: boolean
        isFeature:
          type: boolean
        featureName:
          type: string
        placement:
          type: array
          items:
            $ref: '#/components/schemas/FieldPlacement'
        usage:
          type: array
          items:
            $ref: '#/components/schemas/FieldUsage'
        listEditable:
          type: boolean
        tenantId:
          type: string
        id:
          type: string
        created:
          type: string
          format: date-time
        createdBy:
          type: string
        updated:
          type: string
          format: date-time
        updatedBy:
          type: string
        deleted:
          type: boolean
    DataFieldTime:
      type: object
      properties:
        entity:
          type:
            - 'null'
            - string
        fieldType:
          type:
            - 'null'
            - string
        allowDay:
          type: boolean
        allowHour:
          type: boolean
        allowMinute:
          type: boolean
        defaultValue:
          type: string
        name:
          type: string
        prompt:
          type: string
        description:
          type: string
        isCore:
          type: boolean
        isFeature:
          type: boolean
        featureName:
          type: string
        placement:
          type: array
          items:
            $ref: '#/components/schemas/FieldPlacement'
        usage:
          type: array
          items:
            $ref: '#/components/schemas/FieldUsage'
        listEditable:
          type: boolean
        tenantId:
          type: string
        id:
          type: string
        created:
          type: string
          format: date-time
        createdBy:
          type: string
        updated:
          type: string
          format: date-time
        updatedBy:
          type: string
        deleted:
          type: boolean
    DataFieldToggle:
      type: object
      properties:
        entity:
          type:
            - 'null'
            - string
        fieldType:
          type:
            - 'null'
            - string
        defaultValue:
          type: string
        name:
          type: string
        prompt:
          type: string
        description:
          type: string
        isCore:
          type: boolean
        isFeature:
          type: boolean
        featureName:
          type: string
        placement:
          type: array
          items:
            $ref: '#/components/schemas/FieldPlacement'
        usage:
          type: array
          items:
            $ref: '#/components/schemas/FieldUsage'
        listEditable:
          type: boolean
        tenantId:
          type: string
        id:
          type: string
        created:
          type: string
          format: date-time
        createdBy:
          type: string
        updated:
          type: string
          format: date-time
        updatedBy:
          type: string
        deleted:
          type: boolean
    FieldPlacement:
      type: integer
    FieldUsage:
      type: integer
    DataFieldListData:
      type: object
      properties:
        id:
          type: string
        value:
          type: string
        image:
          type: string
        metadata:
          type: string
        active:
          type: boolean
  securitySchemes:
    Bearer:
      type: http
      description: JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.
      scheme: bearer
      bearerFormat: JWT

````