---
title: "Get extant"
method: GET
path: "/v1/networks"
tags: ["Networks"]
---

# Get extant

`GET /v1/networks`

Gets user's associated networks with basic information.

## Query parameters

- `basic_info` boolean
- `count_network_ips` boolean
- `force_truncate_ips` boolean
- `page` object
  - `number` integer
  - `size` integer
- `protected` boolean
- `search` string
- `unprotected` boolean

## Response `200`

Networks basic information

- object
  - `data` NetworkSpec[]
    - `id` string — Resource Id (integer or uuid)
    - `type` string — Resource type name
    - `uuid` string — Resource UUID (if applicable)
    - `attributes` Network — Network resource
      - `name` string — Network name
      - `physical_address` string — Network physical address (may be null)
      - `latitude` number, double — Network reported latitude
      - `longitude` number, double — Network reported longitude
      - `block_default_appearance` boolean — Default page appearance for blocked pages
      - `block_org_name` string — Blocked page organization name (may be null)
      - `block_email_addr` string — Blocked page email address (may be null)
      - `block_logo_uuid` string — Blocked page custom logo (may be null)
      - `allow_all_policies` boolean — Allow all policies
      - `billing_per_user` boolean — Network usage billing per user
      - `billing_user_count` integer — User network usage count
      - `network_type_units` integer — User network usage count
      - `block_page_id` integer — Block page ID
      - `scheduled_policy_id` integer — Scheduled policy ID
      - `secret_key` string — Network secret key for user agents and LAN proxies
      - `deleted_at` string, date — Item deletion date (may be null)
      - `external_id` string — A unique identifier for external integrations
      - `local_domains` string[] — Array of local domains or DNS suffixes that should bypass filtering
      - `local_resolvers` string[] — Array of IP addresses of local DNS serviers that handle local domains
    - `relationships` object — Network associated resources
      - `organization` object
        - `data` IdType — JSON API resource ID and type attributes
          - `id` string — Resource Id (integer or uuid)
          - `type` string — Resource type name
          - `uuid` string — Resource UUID (if applicable)
      - `ip_addresses` object
        - `data` IdType[]
          - `id` string — Resource Id (integer or uuid)
          - `type` string — Resource type name
          - `uuid` string — Resource UUID (if applicable)
      - `policy` object
        - `data` IdType — JSON API resource ID and type attributes
          - `id` string — Resource Id (integer or uuid)
          - `type` string — Resource type name
          - `uuid` string — Resource UUID (if applicable)
      - `scheduled_policy` object
        - `data` IdType — JSON API resource ID and type attributes
          - `id` string — Resource Id (integer or uuid)
          - `type` string — Resource type name
          - `uuid` string — Resource UUID (if applicable)
      - `block_page` object
        - `data` IdType — JSON API resource ID and type attributes
          - `id` string — Resource Id (integer or uuid)
          - `type` string — Resource type name
          - `uuid` string — Resource UUID (if applicable)
      - `policies` object
        - `data` IdType[]
          - `id` string — Resource Id (integer or uuid)
          - `type` string — Resource type name
          - `uuid` string — Resource UUID (if applicable)
  - `included` IpAddressSpec[]
    - `id` string — Resource Id (integer or uuid)
    - `type` string — Resource type name
    - `uuid` string — Resource UUID (if applicable)
    - `attributes` IpAddress — IpAddress resource
      - `ip` string — IP
      - `address` string — IP address
      - `network_id` integer — Network ID
      - `organization_id` integer — Organization ID
    - `relationships` object — IP address associated network
      - `network` object
        - `data` IdType — JSON API resource ID and type attributes
          - `id` string — Resource Id (integer or uuid)
          - `type` string — Resource type name
          - `uuid` string — Resource UUID (if applicable)
  - `links` Links — JSON API links member representation
    - `self` string — Endpoint URL (may be null)

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

[API](https://skmtc.net/dnsfilter/apis/dnsfilter-api.md) · [All operations](https://skmtc.net/dnsfilter/apis/dnsfilter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dnsfilter/dnsfilter-api/revisions/29e5e6ee3316/schema)