---
title: "List user comments"
method: GET
path: "/v1/user-comments"
tags: ["v1 - User Comments"]
---

# List user comments

`GET /v1/user-comments`

## Request

- Base URL: `https://light.inc` (the document declares no server; this is the origin it was published from)
- URL: `https://light.inc/v1/user-comments`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer

List user comments for a given resource

## Query parameters

- `resourceId` string, uuid
- `sort` string: Sort string in the format `field:direction`. To provide multiple sort fields, separate them with commas. Available directions: `asc`, `desc`. Available fields: `createdAt`.
- `filter` string: Filter string in the format `field:operator:value`. To provide multiple filters, separate them with commas. Available operators: `eq`, `ne`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`. - For `in` and `not_in` operators, provide multiple values separated by the pipe character (`|`). Available fields: `createdBy`, `createdAt`.
- `limit` integer
- `offset` integer
- `cursor` string

## Response `default`

default response

- ExternalPaginatedResponseV1ModelExternalUserCommentV1Model
  - `records` ExternalUserCommentV1Model[]: List of records for the current page
    - `id` string, uuid: ID of the comment.
    - `companyId` string, uuid: ID of the company this comment belongs to.
    - `resourceId` string, uuid: ID of the resource this comment is attached to (e.g. vendor, customer, etc.).
    - `content` string: Comment content.
    - `createdBy` string, uuid: ID of the user who created the comment.
    - `createdAt` string, date-time: Timestamp when the comment was created.
    - `updatedAt` string, date-time: Timestamp when the comment was last updated.
  - `hasMore` boolean: Boolean flag indicating if there are more records available
  - `total` integer, nullable: Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination.
  - `nextCursor` string, nullable: Cursor for fetching the next page (only for cursor pagination)
  - `prevCursor` string, nullable: Cursor for fetching the previous page (only for cursor pagination)

---

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