Apps

Read an app definition

The whole definition: tables, views, rules, pages, members, theme, surfaces.

GET/v1/apps/{appId}

Request

curl --request GET \
  --url 'https://studio.gtable.app/v1/apps/<appId>' \
  --header 'Authorization: Bearer <token>'

import json
import requests

url = "https://studio.gtable.app/v1/apps/<appId>"
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>", {
  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>");
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>", 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>"))
    .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>")
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": {
    "schemaVersion": 123.45,
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "tables": [
      {
        "id": {},
        "name": {},
        "plural": {},
        "description": {},
        "primaryFieldId": {},
        "fields": {}
      }
    ],
    "views": {},
    "rules": {
      "version": 123.45,
      "groups": [
        {
          "id": {},
          "name": {},
          "description": {},
          "assistantMonthlyCredits": {},
          "interface": {}
        }
      ],
      "permissions": [
        {
          "group": {},
          "tables": {}
        }
      ]
    },
    "pages": [],
    "members": [],
    "theme": {
      "radius": 6,
      "accent": "oklch(0.47 0.16 262)",
      "font": "geist"
    },
    "surfaces": {
      "data": true,
      "interface": true,
      "assistant": true,
      "api": true,
      "mcp": true,
      "cli": true
    },
    "updatedAt": "<string>"
  }
}

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

Requires the schema:read scope. Operation apps.get. MCP tool apps_get. CLI, once published: gtable apps get.

Path parameters

Name	Type	Required	Description
`appId`	string	yes

Response

application/json

Success

dataobjectrequired

Show child attributes

schemaVersionnumberrequired

idstringrequired

namestringrequired

slugstringrequired

tablesobject[]required

viewsRecord<string, object[]>required

rulesobjectrequired

pagesobject[]required

membersobject[]required

themeobjectrequired

surfacesobjectrequired

updatedAtstringrequired

{ "data": { "schemaVersion": 123.45, "id": "<string>", "name": "<string>", "slug": "<string>", "tables": [ { "id": {}, "name": {}, "plural": {}, "description": {}, "primaryFieldId": {}, "fields": {} } ], "views": {}, "rules": { "version": 123.45, "groups": [ { "id": {}, "name": {}, "description": {}, "assistantMonthlyCredits": {}, "interface": {} } ], "permissions": [ { "group": {}, "tables": {} } ] }, "pages": [], "members": [], "theme": { "radius": 6, "accent": "oklch(0.47 0.16 262)", "font": "geist" }, "surfaces": { "data": true, "interface": true, "assistant": true, "api": true, "mcp": true, "cli": true }, "updatedAt": "<string>" } }

Read an app definition

Path parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown