> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List building comments

> Returns work order comments across a building. Use it to sync or audit comments.



## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/assetops/work-orders/comments
openapi: 3.1.0
info:
  title: KODE API
  version: 1.0.0
  summary: Programmatic access to KODE OS resources and operations.
  description: >
    Use the KODE API to work with buildings, data sources, connectors, devices,
    points, virtual devices,

    timeseries data, schedules, the ontology, templating, mass writes, spaces,
    space assignments, tenants, meters, users, actions,

    and AssetOps work orders.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.kodelabs.com/kodeos
    description: KODE API
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: OAuth 2.0 discovery, token, and revocation endpoints.
  - name: Buildings
    description: Buildings and their areas.
  - name: Data sources
    description: Data sources connected to a building.
  - name: Devices
    description: Devices and their points.
  - name: Points
    description: Point queries and point writes.
  - name: Timeseries
    description: Current and historical point values.
  - name: Actions
    description: Actions exposed by building data sources.
  - name: Work orders
    description: AssetOps work orders, lookups, comments, and attachments.
  - name: Connectors
    description: KODE API connectors and the devices and points ingested through them.
  - name: Schedules
    description: Schedules discovered on building data sources.
  - name: Templating
    description: Apply ontology templates to groups of points.
  - name: Virtual devices
    description: Virtual devices that group points from other devices.
  - name: Ontology
    description: Canonical types, fields, units, and connections of the KODE ontology.
  - name: Users
    description: Users of the organization and their app access.
  - name: Mass write
    description: Write values to many points across buildings, and follow each run.
  - name: Spaces
    description: Levels and space units of a building, and the meters located in them.
  - name: Space assignments
    description: Assign tenants to leasable spaces of a building for a period.
  - name: Tenants
    description: Tenants of a building, the people or companies that lease its spaces.
  - name: Meters
    description: >-
      Meters of a building, their space assignments, parent and child links, and
      readings.
paths:
  /api/v1/buildings/{buildingId}/assetops/work-orders/comments:
    get:
      tags:
        - Work orders
      summary: List building comments
      description: >-
        Returns work order comments across a building. Use it to sync or audit
        comments.
      operationId: listBuildingWorkOrderComments
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/AscendingSort'
        - $ref: '#/components/parameters/DescendingSort'
        - $ref: '#/components/parameters/Search'
        - $ref: '#/components/parameters/UpdatedAtFrom'
        - $ref: '#/components/parameters/UpdatedAtTo'
      responses:
        '200':
          $ref: '#/components/responses/CommentPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    BuildingId:
      name: buildingId
      in: path
      required: true
      description: Building identifier from List buildings.
      schema:
        type: string
      example: 67c960faffaa42223163099e
    Page:
      name: page
      in: query
      description: Page number to return. The first page is `1`.
      schema:
        type: integer
        minimum: 1
        default: 1
    Limit:
      name: limit
      in: query
      description: Maximum number of items per page.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
    AscendingSort:
      name: asc
      in: query
      description: Field to sort by in ascending order.
      schema:
        type: string
      example: createdAt
    DescendingSort:
      name: dsc
      in: query
      description: Field to sort by in descending order.
      schema:
        type: string
        default: _id
    Search:
      name: q
      in: query
      description: Search text.
      schema:
        type: string
      example: chiller
    UpdatedAtFrom:
      name: updatedAtFrom
      in: query
      description: Return items updated on or after this time (ISO 8601).
      schema:
        type: string
        format: date-time
      example: '2026-10-01T00:00:00Z'
    UpdatedAtTo:
      name: updatedAtTo
      in: query
      description: Return items updated on or before this time (ISO 8601).
      schema:
        type: string
        format: date-time
      example: '2026-10-07T23:59:59Z'
  responses:
    CommentPage:
      description: A page of comments.
      content:
        application/json:
          schema:
            allOf:
              - $ref: '#/components/schemas/Pagination'
              - type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Comment'
    Unauthorized:
      description: The access token is missing, invalid, or expired. Request a new token.
    Forbidden:
      description: The service account lacks permission for this building or operation.
    NotFound:
      description: The resource does not exist or is not assigned to the service account.
    TooManyRequests:
      description: >-
        A rate-limit window is exhausted. Wait, then retry with increasing
        delays.
  schemas:
    Pagination:
      type: object
      properties:
        itemCount:
          type: integer
          description: Total number of matching items.
          example: 1
        limit:
          type: integer
          description: Maximum number of items per page.
          example: 50
        page:
          type: integer
          description: Current page number.
          example: 1
        pageCount:
          type: integer
          description: Total number of pages.
          example: 1
    Comment:
      type: object
      properties:
        id:
          type: string
          example: 6702d0aa1f2e3d4c5b6a7980
        createdAt:
          type: string
          example: 2026-10-07T15:20:00+0000
        updatedAt:
          type: string
          example: 2026-10-07T15:20:00+0000
        author:
          $ref: '#/components/schemas/UserSummary'
        content:
          type: string
          example: Belt replaced. Monitoring startup tomorrow.
        entityId:
          type: string
          description: Work order identifier.
          example: 6702c4e1b8a3f21d9c0e4a17
        entityType:
          type: string
          example: WORK_ORDER
        siteId:
          type: string
          description: Building identifier.
          example: 67c960faffaa42223163099e
        edited:
          type: boolean
          example: false
    UserSummary:
      type: object
      properties:
        id:
          type: string
          example: 64f1a2b3c4d5e6f708192a3b
        firstName:
          type: string
          example: Dana
        lastName:
          type: string
          example: Ruiz
        email:
          type: string
          format: email
          example: dana.ruiz@example.com
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Paste an access token from [Create an access
        token](/products/kode-api/api-reference/authentication/create-an-access-token).
        Tokens expire, so request a new one if you receive `401`.

````

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