List Record Comments

Retrieve all of a record's comments by record Id.

List Comments

Get a Record's comments from a specified Table and Record Id.

list_comments(appId: ID, recordId: ID): Promise<ListCommentsResponse>;

Parameter Name	Type	Description
tableId	string	The Id of the Table containing the record.
recordId	string	The record Id to retrieve comments from.

Example Script - Get Comments

    <!--list_comments(appId: ID, recordId: ID): Promise<ListCommentsResponse>;-->
  <script>
    window.SmartSuite.list_comments('67647d9b7a03fad7da12d9f2', '67647dd4b4761f19a7b55692').then(
      (res) => {
        console.log('result =>>>', res);
      }
    );
  </script>

Response

200 response

{
    "count": null,
    "next": null,
    "previous": null,
    "results": [
        {
            "solution": "67647d9b7a03fad7da12d9f0",
            "application": "67647d9b7a03fad7da12d9f2",
            "record": "67647dd4b4761f19a7b55692",
            "member": "63a1f65723aaf6bcb564b1f1",
            "message": {
                "data": {
                    "type": "doc",
                    "content": [
                        {
                            "type": "paragraph",
                            "attrs": {
                                "textAlign": "left",
                                "size": "medium"
                            },
                            "content": [
                                {
                                    "type": "text",
                                    "text": "This is a test"
                                }
                            ]
                        }
                    ]
                },
                "html": "<div class=\"rendered\">\n    <p class=\"align-left\" >This is a test</p>\n</div>",
                "preview": ""
            },
            "parent_comment": null,
            "created_on": "2024-12-19T22:30:20.422000Z",
            "deleted_on": null,
            "updated_on": null,
            "reactions": [],
            "key": 1,
            "assigned_to": null,
            "resolved_by": "63a1f65723aaf6bcb564b1f1",
            "followers": [
                "63a1f65723aaf6bcb564b1f1"
            ],
            "type": "comment",
            "email": null,
            "field_slug": null,
            "id": "67649e7c9d8ae62e23b556ba"
        },
        {
            "solution": "67647d9b7a03fad7da12d9f0",
            "application": "67647d9b7a03fad7da12d9f2",
            "record": "67647dd4b4761f19a7b55692",
            "member": "63a1f65723aaf6bcb564b1f1",
            "message": {
                "data": {
                    "type": "doc",
                    "content": [
                        {
                            "type": "paragraph",
                            "attrs": {
                                "textAlign": "left",
                                "size": "medium"
                            },
                            "content": [
                                {
                                    "type": "text",
                                    "text": "test!"
                                }
                            ]
                        }
                    ]
                },
                "html": "<div class=\"rendered\">\n    <p class=\"align-left\" >test!</p>\n</div>",
                "preview": ""
            },
            "parent_comment": null,
            "created_on": "2024-12-20T22:18:36.756000Z",
            "deleted_on": null,
            "updated_on": null,
            "reactions": [],
            "key": 2,
            "assigned_to": null,
            "resolved_by": null,
            "followers": [
                "63a1f65723aaf6bcb564b1f1"
            ],
            "type": "comment",
            "email": null,
            "field_slug": null,
            "id": "6765ed3c1ca2a7affd31c2e9"
        },
        {
            "solution": "67647d9b7a03fad7da12d9f0",
            "application": "67647d9b7a03fad7da12d9f2",
            "record": "67647dd4b4761f19a7b55692",
            "member": "63a1f65723aaf6bcb564b1f1",
            "message": {
                "data": {
                    "type": "doc",
                    "content": [
                        {
                            "type": "paragraph",
                            "attrs": {
                                "textAlign": "left",
                                "size": "medium"
                            },
                            "content": [
                                {
                                    "type": "text",
                                    "text": "test2!"
                                }
                            ]
                        }
                    ]
                },
                "html": "<div class=\"rendered\">\n    <p class=\"align-left\" >test2!</p>\n</div>",
                "preview": ""
            },
            "parent_comment": null,
            "created_on": "2024-12-20T22:18:40.446000Z",
            "deleted_on": null,
            "updated_on": null,
            "reactions": [],
            "key": 3,
            "assigned_to": null,
            "resolved_by": null,
            "followers": [
                "63a1f65723aaf6bcb564b1f1"
            ],
            "type": "comment",
            "email": null,
            "field_slug": null,
            "id": "6765ed40c9a94aa718e14738"
        }
    ]
}