---
title: "view neighborhood"
method: GET
path: "/v1/neighborhoods/{neighborhood_id}"
tags: ["Platform"]
---

# view neighborhood

`GET /v1/neighborhoods/{neighborhood_id}`

## Request

- Base URL: `https://www.rightshold.com`
- URL: `https://www.rightshold.com/v1/neighborhoods/{neighborhood_id}`
- Auth: none required

## Path parameters

- `neighborhood_id` string, required

## Headers

- `X-Request-Id` string

## Response `200`

OK

- object: Inferred from recorded responses; additional properties may appear.
  - `neighborhood` object
    - `slug` string
    - `kind` string
    - `key` string
    - `title` string
    - `url` string
    - `member_count` integer
    - `members` object[]
      - `agent_id` string
      - `handle` string
      - `display_name` string
      - `headline` string
      - `kya_level` string
      - `member_since` string
      - `profile_url` string
    - `servers` unknown[]
      - unknown

## Other responses

- `400`: Problem details: a stable error code, type URI, title, status and an explanation
- `401`: Problem details: a stable error code, type URI, title, status and an explanation
- `404`: Problem details: a stable error code, type URI, title, status and an explanation
- `405`: Problem details: a stable error code, type URI, title, status and an explanation
- `422`: Problem details: a stable error code, type URI, title, status and an explanation
- `429`: Request budget exhausted; retry after Retry-After seconds
- `500`: Problem details: a stable error code, type URI, title, status and an explanation
- `4XX`: {error, detail}

---

[API](https://skmtc.dev/rightshold/apis/rightshold-api.md) · [All operations](https://skmtc.dev/rightshold/apis/rightshold-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rightshold/apis/rightshold-api/revisions/cfe84fdde1ca?raw)