---
title: "Get all comments"
method: GET
path: "/1.0/comments"
tags: ["Comments"]
---

# Get all comments

`GET /1.0/comments`

## Request

- Base URL: `https://api.rocketlane.com/api`
- URL: `https://api.rocketlane.com/api/1.0/comments`
- Auth: API key in header `api-key`
- TypeScript: <https://skmtc.dev/rocketlane/apis/rocketlane-api/docs/1.0/comments/get.ts> (a function with typed inputs; its response is checked against the schema)

The Get All Comments API allows users to retrieve all comments within a specific conversation in a project using its unique conversationId. This endpoint returns a paginated response containing all comments associated with the conversation, along with metadata such as timestamps, author details, and status. This API is useful for applications that need to display conversation threads, track discussions, or analyze collaboration trends within a project.

## Query parameters

- `pageSize` number
- `pageToken` string
- `includeAllFields` boolean
- `sortOrder` 'ASC' | 'DESC'
- `match` 'all' | 'any'
- `createdBy.eq` number
- `createdAt.gt` integer
- `createdAt.eq` integer
- `createdAt.lt` integer
- `createdAt.ge` integer
- `createdAt.le` integer
- `includeFields` string[]
- `isPrivate.eq` boolean
- `projectId.eq` integer
- `sourceType` 'TASK' | 'PROJECT_CONVERSATIONS'

## Response `200`

The requested action was successfully executed.

- ExampleAPIResponseComments
  - `data` CommentPublicResponseAPIEntity[]: Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response.
    - `commentId` integer: Unique identifier for the comment
    - `content` string: Content of the comment
    - `createdAt` integer: Timestamp representing the creation time of the comment
    - `createdBy` CommentCreatedByResponsePublicAPIEntity: Details of the user who created the comment
      - `emailId` string: The user's email identifier.
      - `userId` integer: The unique identifier for the user.
      - `firstName` string: The first name of the user.
      - `lastName` string: The last name of the user.
    - `source` CommentSourcePublicAPIResponseEntity, required: Source associated with the comment
      - `sourceId` integer: Source Id attached to the comment
      - `sourceType` 'TASK' | 'PROJECT_CONVERSATIONS': Source Type attached to the comment
    - `attachments` CommentAttachmentPublicAPIResponseEntity[]: List of attachments associated with the comment
      - `attachmentId` integer: Attachment ID
      - `attachmentName` string: Attachment Name
      - `createdAt` integer: Attachment Created timestamp
      - `location` string: Attachment Location
      - `thumbLocation` string: Attachment Thumb location
      - `visibility` boolean: Attachment Visibility
    - `private` boolean: Indicates whether the comment is private or public
  - `pagination` ExamplePaginationConversations: Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages.
    - `pageSize` integer: Denotes the page size mentioned in the current request (limit). It defaults to 100 if left blank.
    - `hasMore` boolean: Tells us if there is more content.
    - `totalRecordCount` integer: Denotes the total resources matching the filters.
    - `nextPage` string: Denotes an API URL, which can be conveniently called to perform the subsequent search call to get to the next page.
    - `nextPageToken` string: Denotes a unique token that points to the next page of resources. To get results from subsequent pages, you can use the nextPageToken available in the response under pagination. This token is valid for 15 minutes.

## Other responses

- `400`: This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.
- `401`: You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.
- `404`: If we were unable to locate the resource you were looking for or the proper API endpoint you were looking for, this error would show up.

## Changes

- **2026-11-03** `a002a499e6fc`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/rocketlane/apis/rocketlane-api/changes/1.0/comments/get.md)

---

[API](https://skmtc.dev/rocketlane/apis/rocketlane-api.md) - [All operations](https://skmtc.dev/rocketlane/apis/rocketlane-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rocketlane/apis/rocketlane-api/revisions/a002a499e6fc?raw)