What a schema change would break

List permission rules, saved views, pages, and other fields that read the fields or tables you propose to remove.

POST/v1/apps/{appId}/schema/impact

Request

curl --request POST \
  --url 'https://studio.grid82.app/v1/apps/<appId>/schema/impact' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "drops": [],
  "renames": []
}'

import json
import requests

url = "https://studio.grid82.app/v1/apps/<appId>/schema/impact"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"drops\":[],\"renames\":[]}")

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

const response = await fetch("https://studio.grid82.app/v1/apps/<appId>/schema/impact", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "drops": [],
    "renames": []
  }),
});

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/apps/<appId>/schema/impact");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"drops\":[],\"renames\":[]}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

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

package main

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

func main() {
  req, _ := http.NewRequest("POST", "https://studio.grid82.app/v1/apps/<appId>/schema/impact", bytes.NewBuffer([]byte("{\"drops\":[],\"renames\":[]}")))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  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.grid82.app/v1/apps/<appId>/schema/impact"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"drops\":[],\"renames\":[]}"))
    .build();

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

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/apps/<appId>/schema/impact")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"drops\":[],\"renames\":[]}"

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": {
    "pages": [
      {
        "pageId": "<string>",
        "name": "<string>",
        "reads": [
          "<string>"
        ],
        "repairable": true
      }
    ],
    "views": [
      {
        "viewId": "<string>",
        "name": "<string>",
        "reads": [
          "<string>"
        ]
      }
    ],
    "rules": [
      {
        "ruleId": "<string>",
        "name": "<string>",
        "reads": [
          "<string>"
        ]
      }
    ],
    "fields": [
      {
        "fieldId": "<string>",
        "name": "<string>",
        "reads": [
          "<string>"
        ]
      }
    ]
  }
}

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

Returns the same list that causes fields.delete and tables.delete to be refused until you send acknowledge=true. Matches pages by the names in their last build; references use IDs, so renaming breaks nothing and returns no results. Advisory only; changes nothing.

Requires the schema:read scope. Operation schema.impact. MCP tool schema_impact. CLI: grid82 schema impact (npx grid82).

Path parameters

Name	Type	Required	Description
`appId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Request body

Field	Type	Required	Description
`drops`	object[]	no	Default `[]`.
`renames`	object[]	no	Default `[]`.

Response

application/json

Success

dataobjectrequired

Show child attributes

data.pagesobject[]required

Show child attributes

data.pages.pageIdstringrequired

data.pages.namestringrequired

data.pages.readsstring[]required

data.pages.repairablebooleanrequired

data.viewsobject[]required

Show child attributes

data.views.viewIdstringrequired

data.views.namestringrequired

data.views.readsstring[]required

data.rulesobject[]required

Show child attributes

data.rules.ruleIdstringrequired

data.rules.namestring

data.rules.readsstring[]required

data.fieldsobject[]

Show child attributes

data.fields.fieldIdstringrequired

data.fields.namestringrequired

data.fields.readsstring[]required

curl --request POST \ --url 'https://studio.grid82.app/v1/apps/<appId>/schema/impact' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "drops": [], "renames": [] }'

{ "data": { "pages": [ { "pageId": "<string>", "name": "<string>", "reads": [ "<string>" ], "repairable": true } ], "views": [ { "viewId": "<string>", "name": "<string>", "reads": [ "<string>" ] } ], "rules": [ { "ruleId": "<string>", "name": "<string>", "reads": [ "<string>" ] } ], "fields": [ { "fieldId": "<string>", "name": "<string>", "reads": [ "<string>" ] } ] } }

What a schema change would break

Path parameters

Headers

Request body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown