---
title: "Read the whole permission document"
description: "Return every role and its permissions in one object."
canonical: "https://grid82.com/docs/builder-api/rules/get"
updated: "2026-11-13"
---

# Read the whole permission document

`GET https://studio.grid82.app/v1/apps/{appId}/rules`

Return every role and its permissions in one object.

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      |             |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`object`, required)
- `data.version` (`number`, required)
- `data.roles` (`object[]`, required, items: `1–100 items`)
- `data.roles.id` (`string`, required, pattern: `^[a-z][a-z0-9_]{0,62}$`)
- `data.roles.name` (`string`, required, length: `1–120 chars`)
- `data.roles.description` (`string`, length: `≤ 500 chars`)
- `data.roles.assistantMonthlyCredits` (`integer`, range: `0–10000000`)
- `data.roles.interface` (`enum<string>`, one of: `assigned, own`)
- `data.roles.automations` (`enum<string>`, one of: `none, own`)
- `data.permissions` (`object[]`, required, items: `≤ 100 items`)
- `data.permissions.role` (`string`, required, pattern: `^[a-z][a-z0-9_]{0,62}$`)
- `data.permissions.tables` (`string | Record<string, object>`, required)
- `data.revision` (`string`, required)

```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>"
  }
}
```

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

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

**Example request**

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