---
title: "List Networks"
method: GET
path: "/v1/sites/{siteId}/networks"
tags: ["Networks"]
---

# List Networks

`GET /v1/sites/{siteId}/networks`

## 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/{siteId}/networks`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-network-api/docs/v1/sites/:siteId/networks/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a paginated list of all Networks on a site.

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

|Name|Type|Allowed functions|
|-|-|-|
|`management`|`STRING`|`eq` `ne` `in` `notIn`|
|`id`|`UUID`|`eq` `ne` `in` `notIn`|
|`name`|`STRING`|`eq` `ne` `in` `notIn` `like`|
|`enabled`|`BOOLEAN`|`eq` `ne`|
|`vlanId`|`INTEGER`|`eq` `ne` `gt` `ge` `lt` `le` `in` `notIn`|
|`deviceId`|`UUID`|`eq` `ne` `in` `notIn` `isNull` `isNotNull`|
|`metadata.origin`|`STRING`|`eq` `ne` `in` `notIn`|
</details>

## Path parameters

- `siteId` string, uuid, required

## Query parameters

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

## Response `200`

OK

- NetworkOverviewPage
  - `offset` integer, required
  - `limit` integer, required
  - `count` integer, required
  - `totalCount` integer, required
  - `data` NetworkOverview[], required
    - `management` string, required
    - `id` string, uuid, required
    - `name` string, required
    - `enabled` boolean, required
    - `vlanId` integer, required: VLAN ID. Must be 1 for the default network and >= 2 for additional networks.
    - `metadata` UserOrSystemDefinedOrOrchestratedEntityMetadata, required
      - `origin` string, required
    - `default` boolean, 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)