---
title: "read: withheld"
description: "Reads the withheld count for one brand or one tenant to The answer gives the count by buyer profile and temperature, with the period and the limit it was read against"
section: reference
address: /reference/read/withheld
contract: 0476e35e6e275db5
---
# read: withheld
Reads the withheld count for one brand or one tenant to The answer gives the count by buyer profile and temperature, with the period and the limit it was read against
[figure: The caller sends WithheldInput to /v1/read/withheld. The platform returns a card whose body is WithheldCount.]
POST/v1/read/withheld
The withheld count. The call needs the brand rung under a token with the read grant, and it is served by the platform.
The route takes [WithheldInput](/concepts/withheldinput) and returns a card whose body is [WithheldCount](/concepts/withheldcount).
## Request body
The request body is [WithheldInput](/concepts/withheldinput).
| field | type | required | note |
|---|---|---|---|
| `brand` | `id` | no | |
| `tenant` | `id` | no | |
| `period` | [Window](/concepts/window) | yes | |
## Response
The route returns a card whose body is [WithheldCount](/concepts/withheldcount). 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 brand rung and a token with the read grant. The platform serves this route.
## Example
The example sends the smallest body that WithheldInput allows. The build validates it against the schema of WithheldInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/read/withheld \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "period": { "from": "…", "to": "…" } }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.read.withheld({
"period": {
"from": "…",
"to": "…"
}
});
// answer.body is a WithheldCount. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/withheld",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"period": {
"from": "…",
"to": "…"
}
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/withheld")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&WithheldInput { /* the fields of the page */ }).send().await?.json().await?;
```