List

GET

https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/comments

GET

/v1/landscapes/:landscapeId/versions/:versionId/comments

1 import { IcePanelClient } from "@icepanel/sdk";
2 
3 async function main() {
4     const client = new IcePanelClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.comments.list("landscapeId", "versionId", {});
8 }
9 main();

1 {
2   "comments": [
3     {
4       "body": {
5         "content": "string",
6         "showContentPreview": true,
7         "status": "open",
8         "type": "question"
9       },
10       "commit": 1.1,
11       "mentionedUserIds": [
12         "string"
13       ],
14       "handleId": "string",
15       "createdAt": "2024-01-15T09:30:00Z",
16       "createdBy": "user",
17       "createdById": "string",
18       "diagrams": {},
19       "id": "string",
20       "landscapeId": "string",
21       "replyCount": 1.1,
22       "updatedAt": "2024-01-15T09:30:00Z",
23       "updatedBy": "user",
24       "updatedById": "string",
25       "version": 1.1,
26       "versionId": "string",
27       "deletedAt": "2024-01-15T09:30:00Z",
28       "deletedBy": "user",
29       "deletedById": "string",
30       "latestEntityId": "string"
31     }
32   ]
33 }

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Query parameters

statuslist of stringsOptional

Response

commentslist of objects

Authentication

Path parameters

Query parameters

Response

Errors