> ## 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.

# Get full board configuration

> Returns all configuration sections for the board in a single response:
fields, automations, options, tabViews, workflows, groups, shares, theme, and filters.




## OpenAPI

````yaml /openapi.yaml get /api/board/{boardId}/configuration
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:
    get:
      tags:
        - Board
      summary: Get full board configuration
      description: >
        Returns all configuration sections for the board in a single response:

        fields, automations, options, tabViews, workflows, groups, shares,
        theme, and filters.
      operationId: getBoardConfiguration
      parameters:
        - name: boardId
          in: path
          required: true
          schema:
            type: string
          description: The board's UUID.
      responses:
        '200':
          description: Full board configuration.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      fields:
                        type: array
                        items:
                          $ref: '#/components/schemas/BoardField'
                      automations:
                        type: array
                        items:
                          $ref: '#/components/schemas/Automation'
                      options:
                        $ref: '#/components/schemas/BoardOptions'
                      tabViews:
                        type: array
                        items:
                          $ref: '#/components/schemas/TabView'
                      workflows:
                        type: array
                        description: Board workflows (sequences).
                        items:
                          type: object
                      groups:
                        type: array
                        description: Field groups (sections) configured on the board.
                        items:
                          type: object
                      shares:
                        type: object
                        description: Board access settings.
                        properties:
                          accessType:
                            type: string
                            enum:
                              - public
                              - private
                          acl:
                            type: array
                            items:
                              type: object
                      theme:
                        type: object
                        description: Board identity fields.
                        properties:
                          name:
                            type: string
                          cardName:
                            type: string
                          color:
                            type: string
                            description: Hex color for the board gradient.
                          icon:
                            type: string
                          description:
                            type: string
                          shortCode:
                            type: string
                      filters:
                        type: array
                        description: Saved filters visible to the caller.
                        items:
                          type: object
        '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).
    Automation:
      type: object
      properties:
        uuid:
          type: string
          description: Unique identifier for the automation.
        title:
          type: string
          description: Display name of the automation.
        automationType:
          type: string
          enum:
            - board
            - schedule
          description: >-
            `board` automations move/copy cards based on board events;
            `schedule` automations run on a time-based schedule.
        archived:
          type: boolean
        destinationBoardUuid:
          type: string
          description: UUID of the destination board. Defaults to the current board.
        sourceBoardUuid:
          type: string
          description: (board type only) UUID of the source board.
        runMode:
          type: string
          description: >-
            Board type: `continuously`, `onDate`, `onMonth`, `dateRange`,
            `onDayOfWeek`. Schedule type: `onDayOfWeek`, `onDate`,
            `onDayOfYear`.
        segment:
          description: (board type only) Card segment/stage filter.
        moveMode:
          type: string
          enum:
            - Copy
            - Move
          description: (board type only) Whether to copy or move matching cards.
        timeOfDay:
          type: number
          description: (schedule type only) Hour of the day to run (0–23).
    BoardOptions:
      type: object
      description: >-
        Configurable board-level settings. All fields are optional — only
        include the ones you want to change on PATCH.
      properties:
        conversionFlair:
          type: string
          enum:
            - confetti
            - fireworks
        reassignDiscussions:
          type: string
          enum:
            - ''
            - prompt
            - auto
        minCallDuration:
          type: number
          description: Minimum call duration in seconds before the call is logged.
        boardEmailOnlyParsedCards:
          type: boolean
        displayFieldNames:
          type: boolean
        agingIndicator:
          type: boolean
        applicationFeatures:
          type: boolean
        applicationLinking:
          type: boolean
        defaultContactType:
          type: string
        updateBadgeField:
          type: string
          description: Field UUID to use as the card badge label.
    TabView:
      type: object
      properties:
        uuid:
          type: string
        name:
          type: string
        url:
          type: string
        icon:
          type: string
        embedSource:
          type: string
        type:
          type: string
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````