---
title: "Retrieve comments"
method: GET
path: "/api/v2/organizations/{orgSlug}/comments"
tags: ["Comments"]
---

# Retrieve comments

`GET /api/v2/organizations/{orgSlug}/comments`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/comments`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.community.comments.read`

Retrieve a paginated list of comments for a single target type. Use `target` and `targetType` in each result to match comments to their entity. 

 Required scopes: `flex.community.comments.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number
- `targetType` 'payment' | 'member' | 'company', required: The type of the entity the comment is on.

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` CommentResultDto[]
    - `_id` string: The _id of the comment.
    - `text` string: The text of the comment.
    - `target` string: The _id of the entity the comment is on.
    - `targetType` 'payment' | 'member' | 'company': The type of the entity the comment is on.
    - `member` string: The _id of the member who posted the comment.
    - `isResolved` boolean: Boolean that shows whether the comment is resolved.
    - `createdAt` string, date-time: The date when the comment has been created.
    - `createdBy` string: The user that created the comment.
    - `modifiedAt` string, date-time: The date when the comment has been last modified.
    - `modifiedBy` string: The user that last updated the comment.

---

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