---
title: "ask: neighbours"
description: "an entity, one kind of connection, and the two dates to the members, one hop away, and whether the cap was reached"
section: reference
address: /reference/ask/neighbours
contract: 0476e35e6e275db5
---
# ask: neighbours
an entity, one kind of connection, and the two dates to the members, one hop away, and whether the cap was reached
[figure: The caller sends NeighboursInput to /v1/ask/neighbours. The platform returns a card whose body is NeighboursAnswer.]
POST/v1/ask/neighbours
Neighbours. The call needs the strategy rung under a token with the ask grant, and it is served by either, by the size bound.
The route takes [NeighboursInput](/concepts/neighboursinput) and returns a card whose body is [NeighboursAnswer](/concepts/neighboursanswer).
## Request body
The request body is [NeighboursInput](/concepts/neighboursinput).
| field | type | required | note |
|---|---|---|---|
| `entity` | `id` | yes | |
| `kind` | [KindOfConnection](/concepts/kindofconnection) | yes | |
| `role` | `text` | no | |
## Response
The route returns a card whose body is [NeighboursAnswer](/concepts/neighboursanswer). 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 ask grant. The platform or the desktop app serves this route.
## Example
The example sends the smallest body that NeighboursInput allows. The build validates it against the schema of NeighboursInput.
Example
```sh
curl -X POST https://api.scaleintelligence.co/v1/ask/neighbours \
-H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/" \
-H "content-type: application/json" \
-d '{ "entity": "…", "kind": "…" }'
```
```typescript
import { client } from "@scale/sdk";
const answer = await client.ask.neighbours({
"entity": "…",
"kind": "…"
});
// answer.body is a NeighboursAnswer. answer.foot holds the basis, the scope and the time.
```
```python
import requests
answer = requests.post("https://api.scaleintelligence.co/v1/ask/neighbours",
headers={"Scale-Key": KEY, "Scale-Scope": "tenant/"},
json={
"entity": "…",
"kind": "…"
}).json()
```
```rust
let answer: Card = client.post("https://api.scaleintelligence.co/v1/ask/neighbours")
.header("Scale-Key", key).header("Scale-Scope", "tenant/")
.json(&NeighboursInput { /* the fields of the page */ }).send().await?.json().await?;
```