Data, as the builder

Count a table's records per value, as the builder

How many rows sit under each value of one column, ordered the way that column sorts.

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

Request

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

import json
import requests

url = "https://studio.gtable.app/v1/apps/<appId>/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://studio.gtable.app/v1/apps/<appId>/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://studio.gtable.app/v1/apps/<appId>/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://studio.gtable.app/v1/apps/<appId>/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://studio.gtable.app/v1/apps/<appId>/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://studio.gtable.app/v1/apps/<appId>/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": {}
  }
}

fieldId takes the field’s id or exact name; an unknown one is refused, listing the table’s fields.

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

Path parameters

Name	Type	Required	Description
`appId`	string	yes
`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 a table's records per value, as the builder

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