GET
/
comment
/
{tableId}
/
{recordId}
/
list
curl --request GET \
  --url 'https://app.teable.cn/api/comment/%7BtableId%7D/%7BrecordId%7D/list?take=20&cursor=SOME_STRING_VALUE&includeCursor=SOME_BOOLEAN_VALUE&direction=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
  "comments": [
    {
      "id": "<string>",
      "content": [
        {
          "type": "p",
          "value": "<any>",
          "children": [
            {
              "type": "span",
              "value": "<string>"
            }
          ]
        }
      ],
      "createdBy": {
        "id": "<string>",
        "name": "<string>",
        "avatar": "<string>"
      },
      "reaction": [
        {
          "reaction": "<string>",
          "user": [
            {
              "id": "<string>",
              "name": "<string>",
              "avatar": "<string>"
            }
          ]
        }
      ],
      "createdTime": "<string>",
      "lastModifiedTime": "<string>",
      "quoteId": "<string>",
      "deletedTime": "<string>"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tableId
string
required
​
recordId
string
required

Query Parameters

​
take

The record count you want to take, maximum is 1000

Example:

20

​
cursor
string | null
​
includeCursor
​
direction
Available options:
forward

Response

200 - application/json
Returns the list of record's comment

The response is of type object.