---
title: "List Local Sites"
method: GET
path: "/v1/sites"
tags: ["Sites"]
---

# List Local Sites

`GET /v1/sites`

## Request

- Base URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration`
- URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/network/integration/v1/sites`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-network-api/docs/v1/sites/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a paginated list of local sites managed by this Network application.
Site ID is required for other UniFi Network API calls.

<details>
<summary>Filterable properties (click to expand)</summary>

|Name|Type|Allowed functions|
|-|-|-|
|`id`|`UUID`|`eq` `ne` `in` `notIn`|
|`internalReference`|`STRING`|`eq` `ne` `in` `notIn`|
|`name`|`STRING`|`eq` `ne` `in` `notIn`|
</details>

## Query parameters

- `offset` integer
- `limit` integer
- `filter` string

## Response `200`

OK

- SiteOverviewPage
  - `offset` integer, required
  - `limit` integer, required
  - `count` integer, required
  - `totalCount` integer, required
  - `data` SiteOverview[], required
    - `id` string, uuid, required
    - `internalReference` string, required: Internal unique name of the site used in older APIs
    - `name` string, required

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-network-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-network-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-network-api/revisions/822d5af98ce5?raw)
