Quick Start
API List
- record
- space
- base
- view
- trash
- field
- dashboard
- aggregation
- table
- selection
- plan
- attachments
- user
- auth
- db-connection
- invitation
- share
- notification
- access-token
- import
- export
- pin
- billing
- admin
- usage
- oauth
- plugin
- comment
- organization
- ai
- integrity
comment
Get comment list
comment
Get comment list
Get record comment list
GET
/
comment
/
{tableId}
/
{recordId}
/
list
curl --request GET \
--url 'https://app.teable.io/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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
The record count you want to take, maximum is 1000
Available options:
forward
Response
200 - application/json
Returns the list of record's comment
curl --request GET \
--url 'https://app.teable.io/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>"
}