---
title: "List circuit groups"
method: GET
path: "/{org_slug}/circuit-groups"
tags: ["Circuits"]
---

# List circuit groups

`GET /{org_slug}/circuit-groups`

## Request

- Base URL: `https://api.obelinf.com`
- URL: `https://api.obelinf.com/{org_slug}/circuit-groups`
- Auth: HTTP bearer

List circuit groups

## Path parameters

- `org_slug` string, required

## Response `200`

List of circuit groups

- object
  - `circuit_groups` object[], required
    - `child_count` number, required
    - `circuit_count` number, required
    - `created_at` string, required
    - `id` string, required
    - `name` string, required
    - `slug` string, required
    - `tags` object[], required
      - `entity_id` string, required
      - `tag_id` string, required
      - `tag_name` string, required
      - `tagged_item_id` string, required
      - `tag_color` string, nullable
    - `updated_at` string, required
    - `description` string, nullable
    - `parent_id` string, nullable
    - `parent_name` string, nullable
  - `total` number, required

---

[API](https://skmtc.dev/obelinf/apis/obelinf-api.md) · [All operations](https://skmtc.dev/obelinf/apis/obelinf-api/llms.txt) · [OpenAPI document](https://skmtc.dev/obelinf/apis/obelinf-api/revisions/463fcf791828?raw)