---
title: "List circuits"
method: GET
path: "/circuits"
tags: ["Circuit"]
---

# List circuits

`GET /circuits`

Retrieves a list of circuit resources; does not supports filtering, sorting, or pagination. Requires admin access.

## Query parameters

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

## Response `200`

A list of circuits

- ListCircuitsEnvelope
  - `meta` Meta, required
    - `filterableFields` string[]
    - `pagination` Pagination
      - `limit` number, required
      - `offset` number, required
      - `totalCount` number, required
    - `apiEnrollmentVersion` string
    - `apiVersion` string
  - `data` CircuitDetail[], required
    - `id` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `_links` Links, required — A map of named links
    - `tags` Tags, required
    - `clientId` string
    - `service` EntityRef, required — A reference to another resource and links to interact with it
      - `entity` string
      - `id` string
      - `name` string
      - `_links` Links — A map of named links
    - `terminator` EntityRef, required — A reference to another resource and links to interact with it
      - `entity` string
      - `id` string
      - `name` string
      - `_links` Links — A map of named links
    - `path` Path, required
      - `nodes` EntityRef[]
        - `entity` string
        - `id` string
        - `name` string
        - `_links` Links — A map of named links
      - `links` EntityRef[]
        - `entity` string
        - `id` string
        - `name` string
        - `_links` Links — A map of named links

## Other responses

- `401` — The currently supplied session does not have the correct access rights to request this resource
- `429` — The resource requested is rate limited and the rate limit has been exceeded

---

[API](https://skmtc.net/openziti/apis/ziti-fabric.md) · [All operations](https://skmtc.net/openziti/apis/ziti-fabric/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openziti/ziti-fabric/revisions/b899875c8f57/schema)