---
title: "List merge fields for a board"
method: GET
path: "/api/board/{boardId}/merge-fields"
tags: ["Board"]
---

# List merge fields for a board

`GET /api/board/{boardId}/merge-fields`

## Request

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

Returns the merge-field catalog the template editors offer for this board, grouped
as the Meteor `useMergeFields` hook groups it: `recipient`, `board`, `sender`,
`showing`, `lease`, `application`, `general`, `company` (the hook's `system` and
`companyFields` groups are named `general` and `company` here, and its per-board
`locations`/`aptlets` groups are one flat `board` list, since the path already
names the board).

`recipient` is the contact field list plus the company's Person custom fields;
`board` is the board's mergeable fields plus the image-embed, card-detail,
contact-table and card-link entries.

## Path parameters

- `boardId` string, required

## Response `200`

The merge-field catalog for this board.

- object
  - `data` MergeFieldCatalog
    - `recipient` MergeFieldItem[]
      - `label` string: Display label.
      - `value` string: The token body. Global groups use a bare key (`firstname`, `customFields.<id>.<NameWithoutSpaces>`, `nowDate`); board items use the `Board["Label"]` form (`Locations["Rent"]`, `Locations["Card Details"]`), except the unit/location link entries, which key on the raw name (`Locations["activeToursLink"]`).
    - `board` MergeFieldItem[]: The fields and card entries of the board in the path. The hook's per-board `locations`/`aptlets` groups, flattened.
      - `label` string: Display label.
      - `value` string: The token body. Global groups use a bare key (`firstname`, `customFields.<id>.<NameWithoutSpaces>`, `nowDate`); board items use the `Board["Label"]` form (`Locations["Rent"]`, `Locations["Card Details"]`), except the unit/location link entries, which key on the raw name (`Locations["activeToursLink"]`).
    - `sender` MergeFieldItem[]
      - `label` string: Display label.
      - `value` string: The token body. Global groups use a bare key (`firstname`, `customFields.<id>.<NameWithoutSpaces>`, `nowDate`); board items use the `Board["Label"]` form (`Locations["Rent"]`, `Locations["Card Details"]`), except the unit/location link entries, which key on the raw name (`Locations["activeToursLink"]`).
    - `showing` MergeFieldItem[]
      - `label` string: Display label.
      - `value` string: The token body. Global groups use a bare key (`firstname`, `customFields.<id>.<NameWithoutSpaces>`, `nowDate`); board items use the `Board["Label"]` form (`Locations["Rent"]`, `Locations["Card Details"]`), except the unit/location link entries, which key on the raw name (`Locations["activeToursLink"]`).
    - `lease` MergeFieldItem[]
      - `label` string: Display label.
      - `value` string: The token body. Global groups use a bare key (`firstname`, `customFields.<id>.<NameWithoutSpaces>`, `nowDate`); board items use the `Board["Label"]` form (`Locations["Rent"]`, `Locations["Card Details"]`), except the unit/location link entries, which key on the raw name (`Locations["activeToursLink"]`).
    - `application` MergeFieldItem[]
      - `label` string: Display label.
      - `value` string: The token body. Global groups use a bare key (`firstname`, `customFields.<id>.<NameWithoutSpaces>`, `nowDate`); board items use the `Board["Label"]` form (`Locations["Rent"]`, `Locations["Card Details"]`), except the unit/location link entries, which key on the raw name (`Locations["activeToursLink"]`).
    - `general` MergeFieldItem[]: Today's date, attachment links, unsubscribe url. The `system` group in the Meteor hook.
      - `label` string: Display label.
      - `value` string: The token body. Global groups use a bare key (`firstname`, `customFields.<id>.<NameWithoutSpaces>`, `nowDate`); board items use the `Board["Label"]` form (`Locations["Rent"]`, `Locations["Card Details"]`), except the unit/location link entries, which key on the raw name (`Locations["activeToursLink"]`).
    - `company` MergeFieldItem[]: Company name, address, contact details and logo. The `companyFields` group in the Meteor hook.
      - `label` string: Display label.
      - `value` string: The token body. Global groups use a bare key (`firstname`, `customFields.<id>.<NameWithoutSpaces>`, `nowDate`); board items use the `Board["Label"]` form (`Locations["Rent"]`, `Locations["Card Details"]`), except the unit/location link entries, which key on the raw name (`Locations["activeToursLink"]`).

## Other responses

- `401`: Invalid or missing credential.
- `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)