Read the whole permission document

Return every role and its permissions in one object.

GET/v1/apps/{appId}/rules

Request

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

import json
import requests

url = "https://studio.grid82.app/v1/apps/<appId>/rules"
headers = {
  "Authorization": "Bearer <token>"
}

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

const response = await fetch("https://studio.grid82.app/v1/apps/<appId>/rules", {
  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.grid82.app/v1/apps/<appId>/rules");
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.grid82.app/v1/apps/<appId>/rules", 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.grid82.app/v1/apps/<appId>/rules"))
    .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.grid82.app/v1/apps/<appId>/rules")
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": {
    "version": 123.45,
    "roles": [
      {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "assistantMonthlyCredits": 123,
        "interface": "assigned",
        "automations": "none"
      }
    ],
    "permissions": [
      {
        "role": "<string>",
        "tables": "<string>"
      }
    ],
    "revision": "<string>"
  }
}

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

Deny by default; a user’s permissions are the union of their roles, so adding a role can only add permissions. Prefer roles.get for one role. revision identifies this document version; send it as baseRevision when replacing the document.

Requires the schema:read scope. Operation rules.get. MCP tool rules_get. CLI: grid82 rules get (npx grid82).

Path parameters

Name	Type	Required	Description
`appId`	string	yes

Response

application/json

Success

dataobjectrequired

Show child attributes

data.versionnumberrequired

data.rolesobject[]requireditems: 1–100 items

Show child attributes

data.roles.idstringrequiredpattern: ^[a-z][a-z0-9_]{0,62}$

data.roles.namestringrequiredlength: 1–120 chars

data.roles.descriptionstringlength: ≤ 500 chars

data.roles.assistantMonthlyCreditsintegerrange: 0–10000000

data.roles.interfaceenum<string>one of: assigned, own

data.roles.automationsenum<string>one of: none, own

data.permissionsobject[]requireditems: ≤ 100 items

Show child attributes

data.permissions.rolestringrequiredpattern: ^[a-z][a-z0-9_]{0,62}$

data.permissions.tablesstring | Record<string, object>required

data.revisionstringrequired

{ "data": { "version": 123.45, "roles": [ { "id": "<string>", "name": "<string>", "description": "<string>", "assistantMonthlyCredits": 123, "interface": "assigned", "automations": "none" } ], "permissions": [ { "role": "<string>", "tables": "<string>" } ], "revision": "<string>" } }

Read the whole permission document

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