---
title: "List all VLANs"
method: GET
path: "/api/v1/vlans"
tags: ["Vlans"]
---

# List all VLANs

`GET /api/v1/vlans`

Returns VLANs accessible to the authenticated user, optionally filtered by network.

## Query parameters

- `group_by` 'created_at' | 'name' | 'vlan_number' | 'updated_at'
- `order_by` 'created_at' | 'name' | 'vlan_number' | 'updated_at'
- `order_direction` 'asc' | 'desc' — Direction for ORDER BY clauses.
- `limit` integer, nullable
- `offset` integer, nullable
- `network_id` string, uuid, nullable
- `at` string, date-time, nullable

## Response `200`

List of VLANs

- PaginatedApiResponseVlan — Response type for paginated list endpoints (pagination is always present in meta)
  - `data` object[], required — The page of results. Empty when nothing matched the query.
    - `description` string, nullable — Free-text notes about the VLAN.
    - `name` string, required — Human-facing name for this VLAN.
    - `network_id` string, uuid, required — The network this entity belongs to.
    - `organization_id` string, uuid, required — The organization that owns this record.
    - `source` union
      - object
        - `type` 'Manual', required
      - object
        - `type` 'System', required
      - object
        - `type` 'Discovery', required
      - object
        - `details` MatchDetails, required
          - `confidence` 'NotApplicable' | 'Low' | 'Medium' | 'High' | 'Certain', required
          - `reason` union, required — Match reason - either a simple reason string or a container with nested reasons
            - object
              - …
            - object
              - …
        - `type` 'DiscoveryWithMatch', required
      - object
        - `type` 'Unknown', required
    - `subnet_ids` string[] — Subnets associated with this VLAN, derived from discovered interface native-VLAN data via the `subnet_vlans` junction. Hydrated by `VlanService` on read; it is not a column on `vlans`, so anything sent here on create/update is ignored by `to_params`.
    - `vlan_number` integer, required — The 802.1Q VLAN number (1-4094)
    - `created_at` string, date-time, required — When this record was first created.
    - `first_discovery_id` string, uuid, nullable — The discovery that first observed this entity.
    - `id` string, uuid, required — Server-assigned unique identifier.
    - `last_discovery_id` string, uuid, nullable — The most recent discovery that observed this entity.
    - `last_seen_at` string, date-time — When a discovery last observed this entity.
    - `lineage_id` string, uuid, nullable — Stable identifier shared by every revision of the same entity across its history.
    - `updated_at` string, date-time, required — When this record was last modified.
    - `valid_from` string, date-time — Start of the interval this revision was current for (SCD2 history).
    - `valid_to` string, date-time, nullable — End of the interval this revision was current for. `null` while it is the live revision.
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `meta` PaginatedApiMeta, required — API metadata for paginated list responses (pagination is always present)
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `pagination` PaginationMeta, required — Pagination metadata returned with paginated responses.
      - `group_counts` GroupCount[], nullable — Size of every group, in the same order the rows are grouped, when the request specified a `group_by`. Lets a paginated client show a group's true size instead of the slice of it that happens to be on this page. Absent when the list isn't grouped.
        - `count` integer, required — How many rows fall in this group in total, not just on this page.
        - `value` string, nullable — The group's value, rendered as text. `null` for rows whose group key is NULL (the "ungrouped" bucket).
      - `has_more` boolean, required — Whether there are more items after this page
      - `limit` integer, required — Maximum items per page (as requested)
      - `offset` integer, required — Number of items skipped
      - `total_count` integer, required — Total number of items matching the filter (ignoring pagination)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

---

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