---
title: "Fetches a list of circuits that the node belongs to"
method: GET
path: "/admin/circuits"
tags: ["Circuits"]
---

# Fetches a list of circuits that the node belongs to

`GET /admin/circuits`

This endpoint can be used to view all or some of the circuits that the
node is a member of. If a node ID is provided via the "filter" query
parameter, only circuits that have the given node ID as a member will be
returned. If a circuit status is provided via the "status" query
parameter, only circuits that have the given circuit status will be
returned; if no filter is provided, all of the node's `Active` circuits
will be returned.

This endpoint requires the permission "circuit.read".

## Query parameters

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

## Headers

- `Authorization` string, required
- `SplinterProtocolVersion` integer

## Response `200`

Successfully retrieved the list of circuits

- object
  - `data` Circuit[]
    - `id` string
    - `members` CircuitMember[] — Circuit members in the circuit
      - `node_id` string
      - `endpoints` string[]
      - `public_key` string
    - `roster` CircuitService[] — All services defined for the circuit
      - `service_id` string
      - `service_type` string
      - `node_id` string — The node ID that is allowed to run this service
    - `management_type` string
    - `display_name` string, nullable — Human readable name for the circuit
    - `circuit_status` 'Active' | 'Disbanded' | 'Abandoned', nullable — The status of the circuit
  - `paging` Paging
    - `current` string
    - `offset` integer
    - `limit` integer
    - `total` integer
    - `first` string
    - `prev` string
    - `next` string
    - `last` string

## Other responses

- `400` — Request was malformed
- `401` — The client is unauthorized
- `500` — An internal server error occurred

---

[API](https://skmtc.dev/cargill/apis/splinterd-api.md) · [All operations](https://skmtc.dev/cargill/apis/splinterd-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cargill/splinterd-api/revisions/38a272c24bd9/schema)
