Records

Count records per value

How many records sit under each value of one column, for the same set a list would return.

GET/v1/tables/{tableId}/records/groups

Request

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

import json
import requests

url = "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/groups?fieldId=<fieldId>"
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/groups?fieldId=<fieldId>", {
  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/groups?fieldId=<fieldId>");
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/groups?fieldId=<fieldId>", 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/groups?fieldId=<fieldId>"))
    .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/groups?fieldId=<fieldId>")
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": {
    "groups": [
      {
        "key": null,
        "count": 123.45
      }
    ],
    "truncated": true
  }
}

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

Keys are raw stored values, ordered the way that column sorts. fieldId takes the field’s id or exact name; a field you cannot read is refused, listing the fields you can.

Requires the records:read scope. Operation records.groups. MCP tool records_groups. CLI, once published: gtable records groups.

Path parameters

Name	Type	Required	Description
`tableId`	string	yes

Query parameters

Name	Type	Required	Description
`viewId`	string	no	Up to 64 characters.
`search`	string	no	Up to 200 characters.
`filter`	string	no	Up to 4000 characters.
`sorts`	string	no	Up to 1000 characters.
`where`	string	no	Up to 4000 characters.
`fieldId`	string	yes	Up to 200 characters.
`limit`	integer	no

Response

application/json

Success

dataobjectrequired

Show child attributes

groupsobject[]required

truncatedbooleanrequired

Count records per value

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