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

# Get board options

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

## Request

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

Returns the current configuration options for the board.

## Path parameters

- `boardId` string, required

## Response `200`

Board options.

- object
  - `data` 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.

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