Comments

Read a record's comments

The notes users have left on this record, oldest first.

GET/v1/tables/{tableId}/records/{recordId}/comments

Request

curl --request GET \
  --url 'https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments' \
  --header 'Authorization: Bearer <token>'

import json
import requests

url = "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments"
headers = {
  "Authorization": "Bearer <token>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments", nil)
  req.Header.Set("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/<recordId>/comments")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": [
    {
      "id": "<string>",
      "tableId": "<string>",
      "recordId": "<string>",
      "authorId": "<string>",
      "text": "<string>",
      "mentions": [
        "<string>"
      ],
      "createdAt": "<string>",
      "editedAt": null
    }
  ]
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

A comment is about the record, never a field of it. If you cannot read the record you are refused rather than told it has none, the difference would confirm it exists.

Requires the records:read scope. Operation comments.list. MCP tool comments_list. CLI, once published: gtable comments list.

Path parameters

Name	Type	Required	Description
`tableId`	string	yes
`recordId`	string	yes

Query parameters

Name	Type	Required	Description
`limit`	integer	no	Default `50`.

Response

application/json

Success

dataobject[]required

Show child attributes

idstringrequired

tableIdstringrequired

recordIdstringrequired

authorIdstringrequired

textstringrequired

mentionsstring[]required

createdAtstringrequired

editedAtstringnullrequired

{ "data": [ { "id": "<string>", "tableId": "<string>", "recordId": "<string>", "authorId": "<string>", "text": "<string>", "mentions": [ "<string>" ], "createdAt": "<string>", "editedAt": null } ] }

Read a record's comments

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown