List the comments on a record
Returns the record's comments with each author's display name and avatar. Requires the `records:read` permission on the database.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/databases/string/records/string/comments"{ "data": [ { "id": "string", "workspaceId": "string", "databaseId": "string", "recordId": "string", "authorUserId": "string", "authorDisplayName": "string", "authorAvatarUrl": "string", "body": "string", "createdAt": "string" } ]}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Ensure a record has a content surface
Returns the page-like description surface attached to the record, creating it on the first call. Responds 201 with `created` true when it minted the surface and 200 when one already existed, so repeated calls are safe. Requires the `records:write` permission.
Comment on a record
Adds a comment to the record, attributed to the calling user's synced profile. Requires the `records:comment` permission on the database, and rejects an empty body or one longer than 2,000 characters.