# indexer.getPermissions

> For the complete documentation index, see [llms.txt](https://ensforge.com/llms.txt).

Lists who can do what over a name, a registration, an account or an ENSv2 registry. Options, result, errors and examples for indexer.getPermissions.

Source: https://ensforge.com/docs/reference/sdk/indexer/get-permissions

<ApiMeta kind="Read" stability="stable" since="1.0.0" source="packages/sdk/src/actions/indexer/getPermissions/index.ts#L56" batchable />

Lists who can do what over a name, a registration, an account or an ENSv2 registry.

## When to use [#when-to-use]

Use to show a name's permission table, or every grant an account holds.

## Details [#details]

- Pass exactly one of `name`, `registrationId`, `address` or `registry`.
- Powers use the indexer's vocabulary (`set_resolver`, `admin_renew`, …); `includeLineage`
  explains how each was obtained.
- Surfaces the indexer cannot list (e.g. operator approvals) are reported through
  `completeness` and `unsupportedReason`.

## Signature [#signature]

```ts
function getPermissions(
  client: Like,
  options: getPermissions.Options,
): Promise<getPermissions.ReturnType>
```

Call it as `ens.indexer.getPermissions(options)` on a client, or `Actions.indexer.getPermissions(client, options)`.

`indexer.getPermissions.request(options)` builds a deferred read for `Actions.batch`. See [Look up many at once](/docs/sdk/look-up-many-at-once).

## Parameters [#parameters]

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `limit` | `number` |  | Rows per page, 1–200. @default 50 |
| `cursor` | `string` |  | The previous page's `cursor`. |
| `includeTotal` | `boolean` |  | Count every row (`totalCount`); slower. |
| `namespace` | `Namespace` |  | Only grants in this namespace. |
| `includeLineage` | `boolean` |  | Include how each grant was obtained. |
| `name` | `string` |  | Permissions over this name. |
| `registrationId` | `string` |  | Permissions over this registration (an indexer handle). |
| `address` | `string` |  | Grants this account holds. |
| `registry` | `{ readonly address: string; readonly chainId?: number \| undefined }` |  | Root grants of this ENSv2 registry (on the client's chain unless `chainId` is set). |

Also takes the [read options](/docs/reference/sdk/client#read-options).

## Returns [#returns]

Resolves to `Page<PermissionRow>`. One page of grants.

## Errors [#errors]

| Error | Codes | When |
| --- | --- | --- |
| [`InvalidInputError`](/docs/reference/errors/invalid-input-error) | [`INVALID_NAME`](/docs/reference/errors/INVALID_NAME), [`INVALID_ADDRESS`](/docs/reference/errors/INVALID_ADDRESS), [`INVALID_RECORD_VALUE`](/docs/reference/errors/INVALID_RECORD_VALUE) | invalid input. |
| [`ConfigError`](/docs/reference/errors/config-error) | [`INDEXER_NOT_CONFIGURED`](/docs/reference/errors/INDEXER_NOT_CONFIGURED) | the client has no indexer. |
| [`IndexerError`](/docs/reference/errors/indexer-error) | [`INDEXER_UNSUPPORTED`](/docs/reference/errors/INDEXER_UNSUPPORTED) | the indexer does not serve the query or its namespace. |
| [`IndexerError`](/docs/reference/errors/indexer-error) | [`INDEXER_UNAVAILABLE`](/docs/reference/errors/INDEXER_UNAVAILABLE), [`INDEXER_RATE_LIMITED`](/docs/reference/errors/INDEXER_RATE_LIMITED), [`INDEXER_BEHIND`](/docs/reference/errors/INDEXER_BEHIND), [`INDEXER_REQUEST_REJECTED`](/docs/reference/errors/INDEXER_REQUEST_REJECTED), [`INDEXER_RESPONSE_INVALID`](/docs/reference/errors/INDEXER_RESPONSE_INVALID) | the indexer is unavailable, rate limiting, behind, rejects the request or answers unexpectedly. |

It can also fail with the errors every read can (`Errors.CommonError`: `ConfigError`, `ContractRevertError`, `InternalError`, `NetworkError`).

See [How errors work](/docs/sdk/errors-explained).

## Examples [#examples]

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Listing a name's permissions"
const page = await ens.indexer.getPermissions({ name: "nick.eth" })
```
</Tab>

<Tab>
```ts title="Listing an account's grants with a standalone call"
import { Actions } from "@ensforge/sdk"

const page = await Actions.indexer.getPermissions(ens, { address })
```
</Tab>

<Tab>
```ts title="Listing a registry's root grants in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

const page = yield* Actions.indexer.getPermissions(ens, { registry: { address: registry } })
```
</Tab>
</Tabs>

## Example response [#example-response]

Recorded from Ethereum mainnet on 2026-11-18 at block 26443964. Values change as the chain does.

```ts
await ens.indexer.getPermissions({ name: "ens.eth", limit: 3 })
```

```json
{
  "asOf": {
    "chainId": 1,
    "blockNumber": "26443964n",
    "blockHash": "0xe75c58ea2f28bd7c6cc53c28a5ab4fc02023f3563661f0a7236a36b779e3ac86",
    "timestamp": "1795029143n"
  },
  "snapshots": {
    "1": {
      "chainId": 1,
      "blockNumber": "26443964n",
      "blockHash": "0xe75c58ea2f28bd7c6cc53c28a5ab4fc02023f3563661f0a7236a36b779e3ac86",
      "timestamp": "1795029143n"
    }
  },
  "asOfToken": null,
  "completeness": "partial",
  "unsupportedReason": "permissions_partially_listed",
  "unsupportedFields": [],
  "origin": null,
  "indexer": "bigname",
  "items": [
    {
      "address": "0x2d2e339c93dA91682Db720ee73e3c8F854f5F246",
      "name": "ens.eth",
      "registrationId": "4f225413-df3a-50b3-832a-1b91e29b6a9c",
      "powers": [
        "resolver_control"
      ],
      "scope": "resolver",
      "relation": null,
      "wrapperState": null,
      "lineage": null
    },
    {
      "address": "0x2d2e339c93dA91682Db720ee73e3c8F854f5F246",
      "name": "ens.eth",
      "registrationId": "4f225413-df3a-50b3-832a-1b91e29b6a9c",
      "powers": [
        "registration_control"
      ],
      "scope": "registration",
      "relation": null,
      "wrapperState": null,
      "lineage": null
    }
  ],
  "cursor": null,
  "hasMore": false,
  "totalCount": null
}
```

## See also [#see-also]

- [`permission.get`](/docs/reference/sdk/permission/get) for the on-chain check