> ## 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 merge fields for a board

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




## OpenAPI

````yaml /openapi.yaml get /api/board/{boardId}/merge-fields
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.0'
  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}/merge-fields:
    get:
      tags:
        - Board
      summary: List merge fields for a board
      description: >
        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.
      operationId: listBoardMergeFields
      parameters:
        - name: boardId
          in: path
          required: true
          schema:
            type: string
          description: The board's UUID.
      responses:
        '200':
          description: The merge-field catalog for this board.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MergeFieldCatalog'
        '401':
          description: Invalid or missing credential.
        '404':
          description: Board not found.
      security:
        - ApiKeyHeader: []
        - DelegateToken: []
components:
  schemas:
    MergeFieldCatalog:
      type: object
      properties:
        recipient:
          type: array
          items:
            $ref: '#/components/schemas/MergeFieldItem'
        board:
          type: array
          description: >-
            The fields and card entries of the board in the path. The hook's
            per-board `locations`/`aptlets` groups, flattened.
          items:
            $ref: '#/components/schemas/MergeFieldItem'
        sender:
          type: array
          items:
            $ref: '#/components/schemas/MergeFieldItem'
        showing:
          type: array
          items:
            $ref: '#/components/schemas/MergeFieldItem'
        lease:
          type: array
          items:
            $ref: '#/components/schemas/MergeFieldItem'
        application:
          type: array
          items:
            $ref: '#/components/schemas/MergeFieldItem'
        general:
          type: array
          description: >-
            Today's date, attachment links, unsubscribe url. The `system` group
            in the Meteor hook.
          items:
            $ref: '#/components/schemas/MergeFieldItem'
        company:
          type: array
          description: >-
            Company name, address, contact details and logo. The `companyFields`
            group in the Meteor hook.
          items:
            $ref: '#/components/schemas/MergeFieldItem'
    MergeFieldItem:
      type: object
      description: >-
        One selectable merge field — the display label and the body of the `{{
        ... }}` token it inserts.
      properties:
        label:
          type: string
          description: Display label.
        value:
          type: string
          description: >
            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"]`).
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    DelegateToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Delegate token issued by the platform. Format: `DelegateToken <token>`'

````