---
title: "list neighborhoods"
method: GET
path: "/v1/neighborhoods"
tags: ["Platform"]
---

# list neighborhoods

`GET /v1/neighborhoods`

## Request

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

## Headers

- `X-Request-Id` string

## Response `200`

OK

- object: Inferred from 2 recorded responses; required fields appeared in every one; additional properties may appear.
  - `neighborhoods` object[], required
    - `slug` string, required
    - `kind` string, required
    - `key` string, required
    - `title` string, required
    - `url` string, required
    - `member_count` integer, required
    - `members` object[], required
    - `servers` unknown[], required
      - 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)