Web API

Press shift + S to search API reference.

Comments

List comments

gethttps://api.airtable.com/v0/{baseId}/{tableIdOrName}/{recordId}/comments

Returns a list of comments for the record from newest to oldest.

Note: Comments in reply to another comment (where parentCommentId is set) may not have their parent comment in the same page of results and vice versa.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopedata.recordComments:read
User role

Base read-only

Billing plansAll plans

Path parameters

baseId
string
tableIdOrName
string
recordId
string

Query parameters

pageSize
optional<number>

If specified, this will determine the number of comments to return. Must be less than or equal to 100. Default is 100.

offset
optional<string>

A pointer to a specific comment. If specified, the returned comments will begin at the specified offset. An offset to the next set of comments will be provided by the API if the number of returned comments exceed the pageSize.

Response format

offset
string | null
comments
array of the below object
id
string

A comment ID

createdTime
string

A date timestamp in the ISO format, eg:"2018-01-01T00:00:00.000Z"

lastUpdatedTime
string | null

A date timestamp in the ISO format, eg: "2018-01-01T00:00:00.000Z", or null if this comment has not been updated since creation.

text
string

The comment text itself. Note that this can contain the user mentioned in the text. See user mentioned for more.

parentCommentId
optional<string>

The comment ID of the parent comment, if this comment is a threaded reply.

mentioned
optional<object>
key: stringUser mentioned
reactions
optional<array of the below object>

A list of reactions on this comment. Each entry contains information about the emoji itself, along with metadata about the user who reacted.

emoji
object
unicodeCharacter
string
reactingUser
object
userId
string

A user ID

email
string
name
optional<string>
author
object
id
string

A user ID

email
string
name
optional<string>
Request (example)
Copy
$
curl "https://api.airtable.com/v0/{baseId}/{tableIdOrName}/{recordId}/comments" \
-H "Authorization: Bearer YOUR_TOKEN"
200 – Response (example)
{
"comments": [
{
"author": {
"email": "foo@bar.com",
"id": "usrL2PNC5o3H4lBEi",
"name": "Foo Bar"
},
"createdTime": "2021-03-01T09:00:00.000Z",
"id": "comB5z37Mg9zaEPw6",
"lastUpdatedTime": null,
"text": "Hello, world!"
},
{
"author": {
"email": "foo@bam.com",
"id": "usrsOEchC9xuwRgKk",
"name": "Foo Bam"
},
"createdTime": "2021-03-01T10:00:00.000Z",
"id": "comeNPu0X9K4Rxzid",
"lastUpdatedTime": null,
"mentioned": {
"usrL2PNC5o3H4lBEi": {
"displayName": "Foo Bar",
"email": "foo@bar.com",
"id": "usrL2PNC5o3H4lBEi",
"type": "user"
}
},
"parentCommentId": "comB5z37Mg9zaEPw6",
"text": "Hello world! Hello @[usrL2PNC5o3H4lBEi]"
}
],
"offset": null
}