---
title: "Parameter"
description: "a named number or choice a reader or a law uses; data a person can change from the console"
section: concepts
address: /concepts/parameter
contract: 0476e35e6e275db5
---

# Parameter

a named number or choice a reader or a law uses; data a person can change from the console

[figure: Parameter is a parameter at platform scope. The drawing shows its fields and the objects that they point at.]

| property | value |
|---|---|
| kind | parameter |
| scope | platform |
| key | its name and where it is set |
| store | postgres |
| family | kernel |



## Fields


| field | type | required | note |
|---|---|---|---|
| `name` | `text` | yes |  |
| `family` | `one of intend \| machinery \| receive \| source` | yes |  |
| `dimension` | `text` | yes |  |
| `value` | `json` | yes |  |
| `set_at_scope` | [Scope](/concepts/scope) | yes |  |
| `enforced_at` | `text` | yes |  |
| `version` | `count` | yes |  |
| `changed_by` | [Caller](/concepts/caller) | no |  |



## Routes that use it
- [`/v1/read/parameter`](/reference/read/parameter) returns it
- [`/v1/act/parameter`](/reference/act/parameter) returns it