# tools.ozone.setting.listOptions

> Published by [ozone-lexicons.bsky.social](https://lexicon.garden/identity/did:plc:33dt5kftu3jq2h5h4jjlqezt)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:33dt5kftu3jq2h5h4jjlqezt/tools.ozone.setting.listOptions)
- [Documentation](https://lexicon.garden/lexicon/did:plc:33dt5kftu3jq2h5h4jjlqezt/tools.ozone.setting.listOptions/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:33dt5kftu3jq2h5h4jjlqezt/tools.ozone.setting.listOptions/examples)

## Definitions

### `tools.ozone.setting.listOptions`

**Type**: `query`

List settings with optional filtering

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `keys` | `array` | No | Filter for only the specified keys. Ignored if prefix is provided |
| `limit` | `integer` | No |  |
| `scope` | `string` | No |  |
| `cursor` | `string` | No |  |
| `prefix` | `string` | No | Filter keys by prefix |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No |  |
| `options` | `array` | Yes |  |

## Raw Schema

```json
{
  "id": "tools.ozone.setting.listOptions",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "options"
          ],
          "properties": {
            "cursor": {
              "type": "string"
            },
            "options": {
              "type": "array",
              "items": {
                "ref": "tools.ozone.setting.defs#option",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "keys": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "nsid"
            },
            "maxLength": 100,
            "description": "Filter for only the specified keys. Ignored if prefix is provided"
          },
          "limit": {
            "type": "integer",
            "default": 50,
            "maximum": 100,
            "minimum": 1
          },
          "scope": {
            "type": "string",
            "default": "instance",
            "knownValues": [
              "instance",
              "personal"
            ]
          },
          "cursor": {
            "type": "string"
          },
          "prefix": {
            "type": "string",
            "description": "Filter keys by prefix"
          }
        }
      },
      "description": "List settings with optional filtering"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```