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

# List board fields

> Returns all fields defined on the board, including archived ones.



## OpenAPI

````yaml /openapi.yaml get /api/board/{boardId}/configuration/fields
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.0'
  description: >
    The Aptly API lets you read and write cards on any Aptly board from external
    systems.


    All requests require an API key passed as the `x-token` header.

    API keys are scoped to your company and work across all boards.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/board/{boardId}/configuration/fields:
    get:
      tags:
        - Board
      summary: List board fields
      description: Returns all fields defined on the board, including archived ones.
      operationId: listBoardFields
      parameters:
        - name: boardId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Array of board fields.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BoardField'
        '401':
          description: Invalid or missing API key.
        '404':
          description: Board not found.
      security:
        - ApiKeyHeader: []
        - PartnerBearer: []
components:
  schemas:
    BoardField:
      type: object
      properties:
        uuid:
          type: string
          description: >-
            Unique field identifier — use this as the key when reading/writing
            card data.
        name:
          type: string
          description: Display name of the field.
        type:
          type: string
          description: >-
            Field type. One of: `text`, `string`, `email`, `tel`, `number`,
            `money`, `date`, `datetime-local`, `boolean`, `singleselect`,
            `multiselect`, `checkboxlist`, `file`, `files`, `url`, `address`,
            `person`, `persons`, `relatedAptlets`, `mirror`, `mirror-contact`,
            `rich-text`, `calculation`, `percent`, `multiplier`, `board`,
            `heroImage`, `embedVideo`, `ai-computed`.
        position:
          type: integer
          description: Display order (zero-based).
        optional:
          type: boolean
          description: Whether the field is optional on cards.
        archived:
          type: boolean
          description: Whether the field has been archived (hidden from the UI).
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````