---
title: "read: candidates"
description: "Reads the candidates of one brand, narrowed by a buyer profile or by a place to Each candidate arrives with the signals gathered about it, the rung it has reached, and what it still lacks to qualify"
section: reference
address: /reference/read/candidates
contract: 0476e35e6e275db5
---
# read: candidates
Reads the candidates of one brand, narrowed by a buyer profile or by a place to Each candidate arrives with the signals gathered about it, the rung it has reached, and what it still lacks to qualify
[figure: The caller sends CandidatesInput to /v1/read/candidates. The platform returns a card whose body is [Candidate].]
POST/v1/read/candidates
Candidates. One candidate. The call needs the strategy rung under a token with the read grant, and it is served by the platform.
The route takes [CandidatesInput](/concepts/candidatesinput) and returns a card whose body is [Candidate](/concepts/candidate).
## Request body
The request body is [CandidatesInput](/concepts/candidatesinput).
| field | type | required | note |
|---|---|---|---|
| `brand` | `id` | yes | |
| `kind_of_buyer` | `id` | no | |
| `place` | `text` | no | |
| `candidate` | `id` | no | one candidate |
## Response
The route returns a card whose body is [Candidate](/concepts/candidate). 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 strategy rung and a token with the read grant. The platform serves this route.
## Example
The example sends the smallest body that CandidatesInput allows. The build validates it against the schema of CandidatesInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/read/candidates \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "brand": "…" }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.read.candidates({
"brand": "…"
});
// answer.body is a [Candidate]. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/read/candidates",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"brand": "…"
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/read/candidates")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&CandidatesInput { /* the fields of the page */ }).send().await?.json().await?;
```