> ## 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 board automations

> Returns the automations configured on a board.



## OpenAPI

````yaml /openapi.yaml get /api/board/{boardId}/configuration/automations
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/automations:
    get:
      tags:
        - Board
      summary: List board automations
      description: Returns the automations configured on a board.
      operationId: listAutomations
      parameters:
        - name: boardId
          in: path
          required: true
          schema:
            type: string
          description: The board's UUID.
      responses:
        '200':
          description: Array of automations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Automation'
        '401':
          description: Invalid or missing API key.
        '404':
          description: Board not found.
      security:
        - ApiKeyHeader: []
        - PartnerBearer: []
components:
  schemas:
    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).
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````