---
title: "List comments"
method: GET
path: "/notes/{note_id}/comments"
tags: ["Comments"]
---

# List comments

`GET /notes/{note_id}/comments`

## Request

- Base URL: `https://api.pipelinecrm.com/api/v3`
- URL: `https://api.pipelinecrm.com/api/v3/notes/{note_id}/comments`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer and API key in header `app-key`
  - API key in query parameter `api_key` and API key in query parameter `app_key`

Comments are attached to notes (called "activities" in the Pipeline UI). In order to get a list of comments, you must query the note by id.

Optionally, you can leave in the company, deal, or company information associated to the note:

  * `GET /companies/:association_id/notes/:note_id/comments.json`
  * `GET /deals/:association_id/notes/:note_id/comments.json`
  * `GET /people/:association_id/notes/:note_id/comments.json`

These are provided to make it easier to construct URLs while exploring the API; the actual :association_id is ignored.

## Path parameters

- `note_id` integer, required

## Response `200`

Successful Response

- object
  - `entries` CommentAll[], required
    - `id` integer: Unique identifier
    - `created_at` string: Timestamp when the record was created (time zone in user's time zone).
    - `updated_at` string: Timestamp when the record was last touched (time zone in user's time zone).
    - `user` object: A convenience object to get the full name of the comment owner
      - `id` integer
      - `first_name` string
      - `last_name` string
      - `avatar_thumb_url` string, nullable
    - `user_id` integer: The owner of the comment
    - `comment` string: The content of the comment
    - `edited_by_person_id` integer: The user id of the last person to edit the note; must be manually set when updating a comment.
  - `pagination` Pagination, required: Paging details returned alongside `entries` on every paginated list.
    - `page` integer: The page returned. Request another with `?page=N`.
    - `per_page` integer: Page size. `?per_page=N`, capped at 200.
    - `total` integer: Total number of records matching the request across all pages.
    - `pages` integer: Number of pages at this `per_page`.
    - `total_in_account` integer, nullable: Total number of records of this type visible to you before filters were applied. Null when not computed for the endpoint.
    - `page_var` string: Name of the query parameter that selects the page. Always `page`.
    - `url` string, nullable: Path of the request, when the endpoint reports it.

## Other responses

- `404`: No record with that id is visible to this user. Records owned by other users that you cannot see also answer 404.

---

[API](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api.md) · [All operations](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pipelinecrm/apis/pipeline-crm-api/revisions/53ebfcc83597?raw)