---
title: "Get full board configuration"
method: GET
path: "/api/board/{boardId}/configuration"
tags: ["Board"]
---

# Get full board configuration

`GET /api/board/{boardId}/configuration`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/board/{boardId}/configuration`
- Auth: one of:
  - API key in header `x-token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/getaptly/apis/aptly-api/docs/api/board/:boardId/configuration/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `boardId` string, required

## Response `200`

Full board configuration.

- object
  - `data` object
    - `fields` BoardField[]
      - `uuid` string: Unique field identifier — use this as the key when reading/writing card data.
      - `name` string: Display name of the field.
      - `type` string: 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` integer: Display order (zero-based).
      - `optional` boolean: Whether the field is optional on cards.
      - `startCard` boolean: Whether the field is shown on the form when a card is created.
      - `archived` boolean: Whether the field has been archived (hidden from the UI).
    - `automations` CardRule[]: The older create-card rules (same data as `GET .../configuration/card-rules`). Despite the name these are not Automations - those are in `workflows` below, kept under this key for backwards compatibility.
      - `uuid` string: Unique identifier for the rule.
      - `title` string: Display name of the automation.
      - `automationType` 'board' | 'schedule': `board` automations move/copy cards based on board events; `schedule` automations run on a time-based schedule.
      - `archived` boolean
      - `destinationBoardUuid` string: UUID of the destination board. Defaults to the current board.
      - `sourceBoardUuid` string: (board type only) UUID of the source board.
      - `runMode` string: Board type: `continuously`, `onDate`, `onMonth`, `dateRange`, `onDayOfWeek`. Schedule type: `onDayOfWeek`, `onDate`, `onDayOfYear`.
      - `segment` unknown
      - `moveMode` 'Copy' | 'Move': (board type only) Whether to copy or move matching cards.
      - `timeOfDay` number: (schedule type only) Hour of the day to run (0–23).
    - `options` BoardOptions: Configurable board-level settings. All fields are optional — only include the ones you want to change on PATCH.
      - `conversionFlair` 'confetti' | 'fireworks'
      - `reassignDiscussions` '' | 'prompt' | 'auto'
      - `minCallDuration` number: Minimum call duration in seconds before the call is logged.
      - `boardEmailOnlyParsedCards` boolean
      - `displayFieldNames` boolean
      - `agingIndicator` boolean
      - `applicationFeatures` boolean
      - `applicationLinking` boolean
      - `defaultContactType` string
      - `updateBadgeField` string: Field UUID to use as the card badge label.
    - `tabViews` TabView[]
      - `uuid` string
      - `name` string
      - `url` string
      - `icon` string
      - `embedSource` string
      - `type` string
    - `workflows` object[]: The board's Automations (same data as `GET .../configuration/automations`). Called workflows here for backwards compatibility.
    - `groups` object[]: Field groups (sections) configured on the board.
    - `shares` object: Board access settings.
      - `accessType` 'public' | 'private'
      - `acl` object[]
    - `theme` object: Board identity fields.
      - `name` string
      - `cardName` string
      - `color` string: Hex color for the board gradient.
      - `icon` string
      - `description` string
      - `shortCode` string
    - `filters` object[]: Saved filters visible to the caller.

## Other responses

- `401`: Invalid or missing API key.
- `404`: Board not found.

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)