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

# List the comments on a document

> The comments on one of the client’s documents, oldest first, with the replies under them. A comment carries an anchor when it points at a place on a page. Every comment is also a message in the client’s thread. Answer one with post_message and reply_to.



## OpenAPI

````yaml /openapi/advisor.json get /clients/{client}/documents/{document}/comments
openapi: 3.1.0
info:
  title: Redbark Advisor API
  version: 2.0.0
  description: >-
    Read and write access to one advice firm in Redbark Advisor: clients,
    checklists, documents, money, messages, reports, team and webhooks. Send an
    API key or a connected app’s access token as a bearer token. A credential
    carries scopes, one read and one write per area, and each call says the
    scope it needs. A write scope brings its read scope. Each key may make 120
    requests a minute.
servers:
  - url: https://advisor.redbark.com/api/v1
security:
  - bearerAuth: []
tags:
  - name: Firm
    description: The firm, its name and its branding.
  - name: Team
    description: Team members and their roles.
  - name: Clients
    description: Clients, their people and portal invites.
  - name: Checklists
    description: Checklist templates, the checklists sent to clients and their answers.
  - name: Documents
    description: Documents clients upload and the details read from them.
  - name: Money
    description: Bank connections, accounts, balances and transactions.
  - name: Document types
    description: Document types, their fields and the client facts they fill.
  - name: Messages
    description: Messages between the firm and clients.
  - name: Reports
    description: Reports exported for clients.
  - name: Webhooks
    description: Webhook endpoints and their deliveries.
  - name: Webhook events
    description: Events sent to your webhook endpoints.
paths:
  /clients/{client}/documents/{document}/comments:
    get:
      tags:
        - Messages
      summary: List the comments on a document
      description: >-
        The comments on one of the client’s documents, oldest first, with the
        replies under them. A comment carries an anchor when it points at a
        place on a page. Every comment is also a message in the client’s thread.
        Answer one with post_message and reply_to.
      operationId: list_document_comments
      parameters:
        - name: client
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 60
            description: The client id, from list_clients.
        - name: document
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 60
            description: The document id, from list_documents.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentCommentList'
        '400':
          description: The request is not valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The API key or access token is missing, wrong, expired or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            subscription_required: the firm has no active subscription, so it
            cannot add or invite clients or send checklists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The credential lacks the scope this call needs, the call is for
            admins only, or the member it acts as has left the firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource in this firm.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            The resource is in a state that does not allow this, such as an
            archived client, or client_limit_reached: the plan’s 20 active
            clients are in use.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: The request body is too large.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests. See the Retry-After header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Something went wrong on our side. Try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - messages:read
components:
  schemas:
    DocumentCommentList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Message'
        has_more:
          type: boolean
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
        next_page_url:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - object
        - data
        - has_more
        - next_cursor
        - next_page_url
      additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              anyOf:
                - type: string
                - type: 'null'
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - param
            - request_id
          additionalProperties: true
      required:
        - error
      additionalProperties: true
    Message:
      type: object
      properties:
        object:
          type: string
          enum:
            - message
        id:
          type: string
        client_id:
          type: string
        author_kind:
          type: string
          enum:
            - member
            - person
            - system
          description: >-
            member is someone at the firm, person is the client, system is a
            line the app posts, such as "Anna uploaded a payslip".
        author_name:
          anyOf:
            - type: string
            - type: 'null'
        body:
          type: string
          description: The text. For a system line, the line as shown.
        system_event:
          anyOf:
            - type: string
            - type: 'null'
        document_id:
          anyOf:
            - type: string
            - type: 'null'
        document_name:
          anyOf:
            - type: string
            - type: 'null'
        anchor:
          anyOf:
            - $ref: '#/components/schemas/MessageAnchor'
            - type: 'null'
        checklist_item_id:
          anyOf:
            - type: string
            - type: 'null'
        reply_to:
          anyOf:
            - type: string
            - type: 'null'
          description: The document comment this replies to.
        created_at:
          type: string
          description: An ISO 8601 time in UTC.
        edited_at:
          anyOf:
            - type: string
              description: An ISO 8601 time in UTC.
            - type: 'null'
      required:
        - object
        - id
        - client_id
        - author_kind
        - author_name
        - body
        - system_event
        - document_id
        - document_name
        - anchor
        - checklist_item_id
        - reply_to
        - created_at
        - edited_at
      additionalProperties: true
    MessageAnchor:
      type: object
      properties:
        page:
          type: number
          description: The page, from 1.
        rects:
          type: array
          items:
            type: object
            properties:
              x:
                type: number
              'y':
                type: number
              width:
                type: number
              height:
                type: number
            required:
              - x
              - 'y'
              - width
              - height
            additionalProperties: true
          description: >-
            Boxes on the page, each as fractions of the page width and height
            from the top left.
        quote:
          anyOf:
            - type: string
              description: The text highlighted.
            - type: 'null'
      required:
        - page
        - rects
      additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A firm API key, shown once when it is made, or a connected app’s OAuth
        access token. Each operation lists the scope it needs, such as
        clients:write.

````

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