> ## 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.1'
  description: |
    The Aptly API lets external systems work with boards, contacts, inboxes,
    tasks, files, and other Aptly resources.

    Most endpoints accept an API key in the `x-token` header. Some endpoints
    also accept a delegate token or partner bearer token, as shown in each
    operation's security requirements, and explicitly public endpoints require
    no credential. API keys are scoped to a company and may be restricted to
    specific boards and read, insert, or update permissions; requests outside
    those restrictions receive a 403 `FORBIDDEN` response.
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. Fields created through the API use one of the types in
            `NewBoardFieldType` (`string`, `text`, `rich-text`, `number`,
            `money`, `percent`, `multiplier`, `boolean`, `date`,
            `datetime-local`, `email`, `emails`, `tel`, `phones`, `url`,
            `address`, `person`, `persons`, `user`, `file`, `files`,
            `heroImage`, `embedVideo`, `stringList`, `tags`, `singleselect`,
            `multiselect`, `checkboxlist`). Mirror fields (a copy of another
            board's field) are added with `POST
            /api/board/{boardId}/configuration/mirror-fields` and take the
            mirrored field's type. Boards built in the Aptly app can also
            contain relational and system types, e.g. `stageselect`,
            `sourceselect`, `relatedAptlets`, `mirror`, `mirror-contact`,
            `location`, `unit`, `board`, `calculation`, `ai-computed`, `cardId`,
            `daysOpened`, `timeSince`, `qualified`, `lostReason`, `lostDetails`,
            `relatedEvents`, `relatedDocuments`, `contactType`, `teams`.
        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>`'

````

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