Get Comment List

POST

/comment/page

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://app.workzappy.com/openapi/api/comment/page' \
--header 'accessToken: {{accessToken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "commentModule": "issue",
    "linkId": 1,
    "pageNumber": 1,
    "pageSize": 10
}'

Response Example

{
    "code": "0",
    "data": {
        "extend": {
            "totalCommentNo": 2
        },
        "total": 2,
        "list": [
            {
                "deleteFlag": 0,
                "stickerVOList": [
                    {
                        "containsSelf": true,
                        "replyUserList": [
                            {
                                "name": "eee",
                                "avatar": "ddd",
                                "id": 3,
                                "orgUserId": 4
                            }
                        ],
                        "stickerCode": "fff"
                    }
                ],
                "commentAttributes": {
                    "commentAtInfos": []
                },
                "createTime": 1660724394130,
                "subReplies": [],
                "commentUser": {
                    "headPortrait": "aaa",
                    "userName": "bbb",
                    "userId": 2
                },
                "commentId": 1,
                "files": [],
                "updateTime": 1660724394130,
                "content": "ccc"
            },
            {
                "deleteFlag": 0,
                "stickerVOList": [],
                "createTime": 1660724446300,
                "subReplies": [
                    {
                        "deleteFlag": 0,
                        "stickerVOList": [],
                        "createTime": 1661213779644,
                        "groupId": 5,
                        "commentUser": {
                            "headPortrait": "jjj",
                            "userName": "kkk",
                            "userId": 8
                        },
                        "replyId": 5,
                        "commentId": 7,
                        "files": [],
                        "updateTime": 1661213779644,
                        "linkedIssueDeleteFlag": 0,
                        "content": "lll"
                    }
                ],
                "commentUser": {
                    "headPortrait": "ggg",
                    "userName": "hhh",
                    "userId": 6
                },
                "commentId": 5,
                "files": [],
                "updateTime": 1660724446300,
                "content": "iii"
            }
        ]
    }
}

Request

Header Params

Content-Type

string

required

Example:

application/json

accessToken

string

required

Example:

Body Params application/json

commentModule

string

required

Comment Module (.eg. issue)

linkId

integer <int64>

required

Link ID

pageNumber

integer <int32>

optional

Page Number

pageSize

integer <int32>

optional

Page Size

Examples

Responses

🟢200OK

application/json

Body

commentNo

integer <int32>

optional

Comment Count

commentAttributes

object

optional

Comment Attributes

commentAtInfos

array [object]

optional

Comment @User Info

plainContent

string

optional

Comment Content(plain content)

subReplies

array [object]

optional

Reply Comment List

commentUser

object

optional

Comment User Info

userName

string

optional

User Name

userId

integer <int64>

optional

User ID

accountEnabled

string <byte>

optional

Account Enabled (0:No,1:Yes)

<= 4 characters

updateTime

string <date>

optional

Last Update Time

content

string

optional

Comment Content

deleteFlag

string <byte>

optional

Deleted (1:Yes, 0:No)

<= 4 characters

stickerVOList

array [object]

optional

Sticker List

createBy

integer <int64>

optional

Comment Creator

createTime

string <date>

optional

Creation Time

commentId

integer <int64>

optional

Comment ID

files

array [object]

optional

Attachments

Modified at 2025-03-20 02:41:15

Remove Comment

Update Comment Sticker