GET
/
comment
/
{tableId}
/
{recordId}
/
count
curl --request GET \
  --url 'https://app.teable.io/api/comment/%7BtableId%7D/%7BrecordId%7D/count?projection=SOME_ARRAY_VALUE&cellFormat=SOME_STRING_VALUE&fieldKeyType=SOME_STRING_VALUE&viewId=viwXXXXXXX&ignoreViewQuery=SOME_STRING_VALUE&filterByTql=%7Bfield%7D+%3D+%27Completed%27+AND+%7Bfield%7D+%3E+5&filter=SOME_STRING_VALUE&search=SOME_ARRAY_VALUE&filterLinkCellCandidate=fldXXXXXXX&filterLinkCellCandidate=recXXXXXXX&filterLinkCellSelected=fldXXXXXXX&filterLinkCellSelected=recXXXXXXX&selectedRecordIds=SOME_ARRAY_VALUE&orderBy=SOME_STRING_VALUE&groupBy=SOME_STRING_VALUE&collapsedGroupIds=SOME_ARRAY_VALUE&take=100&skip=0' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
  "count": 123
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
tableId
string
required

Query Parameters

​
projection
string[]

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained, The parameter value depends on the specified fieldKeyType to determine whether it is name or id

​
cellFormat
enum<string>
default:json

Define the return value formate, you can set it to text if you only need simple string value

Available options:
json,
text
​
fieldKeyType
enum<string>
default:name

Define the key type of record.fields[key], You can click "systemInfo" in the field edit box to get fieldId or enter the table design screen with all the field details

Available options:
id,
name,
dbFieldName
​
viewId
string

Set the view you want to fetch, default is first view. result will filter and sort by view options.

Example:

"viwXXXXXXX"

​
ignoreViewQuery

When a viewId is specified, configure this to true will ignore the view's filter, sort, etc

​
filterByTql
string
deprecated
Example:

"{field} = 'Completed' AND {field} > 5"

​
filter
string

A filter object used to filter results. It allows complex query conditions based on fields, operators, and values.

​
search

Search for records that match the specified field and value

Required array length: 1 element
​
filterLinkCellCandidate

Filter out the records that can be selected by a given link cell from the relational table. For example, if the specified field is one to many or one to one relationship, recordId for which the field has already been selected will not appear.

Required array length: 2 elements
Example:
["fldXXXXXXX", "recXXXXXXX"]
​
filterLinkCellSelected

Filter out selected records based on this link cell from the relational table. Note that viewId, filter, and orderBy will not take effect in this case because selected records has it own order. Ignoring recordId gets all the selected records for the field

Required array length: 2 elements
Example:
["fldXXXXXXX", "recXXXXXXX"]
​
selectedRecordIds
string[]

Filter selected records by record ids

​
orderBy
string

An array of sort objects that specifies how the records should be ordered.

​
groupBy
string

An array of group objects that specifies how the records should be grouped.

​
collapsedGroupIds
string[]

An array of group ids that specifies which groups are collapsed

​
take

The record count you want to take, maximum is 2000

Example:

100

​
skip

The records count you want to skip

Example:

0

Response

200 - application/json

Returns the comment count by query

The response is of type object.