---
title: "read: parameter"
description: "its name to its value, with its dimension and version"
section: reference
address: /reference/read/parameter
contract: 0476e35e6e275db5
---
# read: parameter
its name to its value, with its dimension and version
[figure: The caller sends ParameterInput to /v1/read/parameter. The platform returns a card whose body is Parameter.]
POST/v1/read/parameter
Read a parameter. The call needs the tenant rung under a token with the read grant, and it is served by the platform.
The route takes [ParameterInput](/concepts/parameterinput) and returns a card whose body is [Parameter](/concepts/parameter).
## Request body
The request body is [ParameterInput](/concepts/parameterinput).
| field | type | required | note |
|---|---|---|---|
| `name` | `text` | yes | |
| `scope` | [Scope](/concepts/scope) | no | |
## Response
The route returns a card whose body is [Parameter](/concepts/parameter). Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.
## Headers
| header | required | meaning |
|---|---|---|
| `Scale-Scope` | yes | the scope the call runs in: tenant/, then /brand/, then /strategy/ |
| `Scale-As-True-On` | no | the date the facts must have been true on; defaults to now |
| `Scale-As-Known-On` | no | the date the facts must have been known on; defaults to now |
| `Scale-Key` | no | for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing |
A caller needs the tenant rung and a token with the read grant. The platform serves this route.
## Example
The example sends the smallest body that ParameterInput allows. The build validates it against the schema of ParameterInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/read/parameter \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "name": "…" }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.read.parameter({
"name": "…"
});
// answer.body is a Parameter. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/parameter",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"name": "…"
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/parameter")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&ParameterInput { /* the fields of the page */ }).send().await?.json().await?;
```