Comments

List comments

List comments in a project. Use targetKind and targetId together to filter by resource.

get/projects/{projectId}/comments

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/projects/{projectId}/comments
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

sortstring

Field to sort by. Allowed fields depend on the resource.

order'asc' | 'desc'

Sort direction.

withCountboolean

Include the total number of matching items. Defaults to false.

targetKind'project' | 'budgetLine' | 'transaction' | 'purchaseOrder' | 'contact' | 'document'

Resource type associated with a comment.

Resource type. Use with targetId.

targetIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Resource ID. Use with targetKind.

threadIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Only replies under this root comment.

resolvedboolean

Filter by resolution state.

Response

A page of comments.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total matching items; present only when withCount=true was requested.

truncatedboolean

Whether some matching items were omitted from the response.

Example response

{
  "data": [
    {
      "id": "txn_8f2a1c9e",
      "projectId": "txn_8f2a1c9e",
      "threadId": "txn_8f2a1c9e",
      "target": {
        "id": "txn_8f2a1c9e"
      },
      "author": {
        "id": "txn_8f2a1c9e"
      },
      "tags": [
        {
          "id": "txn_8f2a1c9e",
          "targetId": "txn_8f2a1c9e"
        }
      ],
      "reactions": [
        {
          "users": [
            {
              "id": "txn_8f2a1c9e"
            }
          ]
        }
      ]
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.