> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plane.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a preference definition

> Inspect the allowed values, default, and owner scope for a preference.

<ParamField path="key" type="string" required>Registered preference key.</ParamField>

### Returns

<ResponseField name="object" type="string">Always `preference_definition`.</ResponseField>
<ResponseField name="key" type="string">Registered key.</ResponseField>
<ResponseField name="name" type="string">Human-readable setting name.</ResponseField>
<ResponseField name="description" type="string">What the setting controls.</ResponseField>
<ResponseField name="scope" type="string">Required owner scope: `workspace`, `member`, or `user`.</ResponseField>
<ResponseField name="schema" type="object">JSON Schema describing valid replacement values.</ResponseField>
<ResponseField name="default" type="any">Value restored by reset.</ResponseField>

```json theme={null}
{
  "object": "preference_definition",
  "key": "payment_requests.requirements",
  "name": "Required details",
  "description": "Details required in the worker payment-request form. Invoice requires a file and invoice number; dates requires dates covered.",
  "scope": "workspace",
  "schema": {
    "type": "array",
    "items": { "type": "string", "enum": ["invoice", "dates"] }
  },
  "default": []
}
```

Unknown keys return `404`.