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

# Get a board's activity feed

> One merged, newest-first feed for this board: card and board-configuration changes,
automation log rows (runs and configuration edits) and card comments. Every read is
pinned to this board and bounded in time (the last 92 days, or 365 when `cardId` is given).
Page with `before`: pass the `nextCursor` of the previous page; it is `null` on the last page.
Change values are shortened (long text is clipped, large structures summarised as
`[N items]`), and automation configuration snapshots are not included.
Webhook URL credentials are masked in both current and previous change values.
Audit rows containing both comments and other changes match both type filters. When
both are requested, each mixed row appears once as a change item with comments included.
Unrelated query parameters (including `x-token` authentication and cache-busters)
are ignored when validating the activity filters.
Needs a credential that can administer the board's configuration (an API key, or an
internal partner token with `board-admin`); delegate tokens are refused even when
an `x-token` is also supplied in a header or query parameter.




## OpenAPI

````yaml /openapi.yaml get /api/board/{boardId}/activity
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.1'
  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}/activity:
    get:
      tags:
        - Board
      summary: Get a board's activity feed
      description: >
        One merged, newest-first feed for this board: card and
        board-configuration changes,

        automation log rows (runs and configuration edits) and card comments.
        Every read is

        pinned to this board and bounded in time (the last 92 days, or 365 when
        `cardId` is given).

        Page with `before`: pass the `nextCursor` of the previous page; it is
        `null` on the last page.

        Change values are shortened (long text is clipped, large structures
        summarised as

        `[N items]`), and automation configuration snapshots are not included.

        Webhook URL credentials are masked in both current and previous change
        values.

        Audit rows containing both comments and other changes match both type
        filters. When

        both are requested, each mixed row appears once as a change item with
        comments included.

        Unrelated query parameters (including `x-token` authentication and
        cache-busters)

        are ignored when validating the activity filters.

        Needs a credential that can administer the board's configuration (an API
        key, or an

        internal partner token with `board-admin`); delegate tokens are refused
        even when

        an `x-token` is also supplied in a header or query parameter.
      operationId: getBoardActivity
      parameters:
        - name: boardId
          in: path
          required: true
          schema:
            type: string
          description: The board's UUID.
        - name: types
          in: query
          required: false
          schema:
            type: string
            example: changes,comments
          description: >-
            Comma-separated kinds to include, from `changes`, `automations`,
            `comments`. Default all three.
        - name: cardId
          in: query
          required: false
          schema:
            type: string
          description: Only this card's activity. Board-configuration changes are left out.
        - name: before
          in: query
          required: false
          schema:
            type: string
          description: The `nextCursor` of the previous page.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
      responses:
        '200':
          description: A page of activity.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      boardUuid:
                        type: string
                      types:
                        type: array
                        items:
                          type: string
                          enum:
                            - changes
                            - automations
                            - comments
                      since:
                        type: string
                        format: date-time
                        description: Start of the window the feed covers.
                      nextCursor:
                        type: string
                        nullable: true
                      items:
                        type: array
                        items:
                          type: object
                          required:
                            - id
                            - type
                            - createdAt
                            - actor
                          properties:
                            id:
                              type: string
                            type:
                              type: string
                              enum:
                                - change
                                - automation
                                - comment
                            createdAt:
                              type: string
                              format: date-time
                            actor:
                              type: object
                              properties:
                                userId:
                                  type: string
                                  nullable: true
                                name:
                                  type: string
                                  nullable: true
                            cardId:
                              type: string
                            cardName:
                              type: string
                            scope:
                              type: string
                              enum:
                                - card
                                - board
                              description: change items only.
                            action:
                              type: string
                              description: >-
                                change items only: created, edited, archived,
                                reopened or deleted.
                            changes:
                              type: array
                              description: change items only.
                              items:
                                type: object
                                properties:
                                  field:
                                    type: string
                                  fieldName:
                                    type: string
                                  fieldType:
                                    type: string
                                  display:
                                    type: string
                                  value: {}
                                  previous: {}
                            comments:
                              type: array
                              description: >-
                                Present on comment items and mixed change items
                                when comments are requested. `removed` marks a
                                deleted comment.
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  text:
                                    type: string
                                  author:
                                    type: string
                                  removed:
                                    type: boolean
                            kind:
                              type: string
                              enum:
                                - run
                                - configuration
                              description: automation items only.
                            automationType:
                              type: string
                            automationUuid:
                              type: string
                            automationName:
                              type: string
                            description:
                              type: string
                            success:
                              type: boolean
                            error:
                              type: string
        '400':
          description: >-
            Invalid query (unknown `types` value, bad `limit`, malformed
            `before`).
        '401':
          description: Invalid or missing credential.
        '403':
          description: The credential cannot administer this board.
        '404':
          description: Board not found.
      security:
        - ApiKeyHeader: []
        - PartnerBearer: []
components:
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.