---
title: "Get Residents"
method: GET
path: "/addresses/{geo_id}/residents"
tags: ["Addresses"]
---

# Get Residents

`GET /addresses/{geo_id}/residents`

Return residents for a given address geo ID. Results are paginated using cursor-based pagination.

## Path parameters

- `geo_id` string, required — Address geo ID

## Query parameters

- `cursor` string, nullable — Cursor for pagination
- `size` integer

## Response `200`

Residents for a given address geo ID

- PaginatedResidentsResponse — Paginated response for residents.
  - `items` ResidentsRead[], required — The list of items returned in the response following given criteria.
    - `name` string, nullable
    - `personal_emails` string, nullable
    - `phone` string, nullable
    - `linkedin_url` string, nullable
    - `net_worth` string, nullable
    - `income_range` string, nullable
    - `is_homeowner` boolean, nullable
    - `street_no` string, nullable
    - `street` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `zip_code` string, nullable
    - `zip_code_ext` string, nullable
  - `size` integer, required — The number of items returned in the response.
  - `next_cursor` string, nullable, required — The cursor for retrieving the next page of results.
  - `total_count` TotalCount — Capped result count with Elasticsearch-style {value, relation} shape. When the exact count is known and within the cap, relation is "eq" and value is that exact count. When the count exceeds the cap, relation is "gte" and value is the cap the count was probed against, meaning "the actual count is at least value". The cap is COUNT_CAP for every wire-facing endpoint; internal guard paths probe against their own cap, so value carries whatever cap produced it.
    - `value` integer, required — The count value; capped at the probe's cap (10,000 on the wire).
    - `relation` 'eq' | 'gte', required — "eq" means value is the exact count. "gte" means the actual count is at least value (the cap).

## Other responses

- `404` — The given geo_id doesn't have residents information.
- `422` — Validation Error

---

[API](https://skmtc.net/shovels/apis/the-shovels-api-v2.md) · [All operations](https://skmtc.net/shovels/apis/the-shovels-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shovels/the-shovels-api-v2/revisions/64df4c8074f5/schema)