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

> Read a preference's effective value and registered default.

<ParamField path="key" type="string" required>
  Registered key, such as `payment_requests.requirements`.
</ParamField>

<ParamField query="scope" type="string">
  `workspace` (default), `member`, or `user`. Must match the key's registered
  scope. Personal scopes require a signed-in person.
</ParamField>

### Returns

The [Preference object](/reference/preferences/object). Unset keys return their
default. Unknown keys return `404`; a scope that does not match the registered
key returns a validation error.