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

# List counters

`GET /counters/`

This method retrieves the list of counters.

## Query parameters

- `active` boolean
- `calibration_status` 'AWAITING_PROXIMITY_MODEL' | 'AWAITING_SYNC' | 'CALIBRATED' | 'COLLECTING_CALIBRATION_DATA' | 'NOT_CALIBRATED'
- `camera_groups` integer[]
- `cameras` integer[]
- `color` string[]
- `count_interval_gte` integer
- `count_interval_lte` integer
- `created_date_gt` string, date-time
- `created_date_gte` string, date-time
- `created_date_last_n_days` number
- `created_date_lt` string, date-time
- `created_date_lte` string, date-time
- `created_date_nth_full_week` number
- `created_date_nth_work_week` number
- `detect_cars` boolean
- `detect_faces` boolean
- `detect_proximity` boolean
- `detect_silhouettes` boolean
- `id_in` integer[]
- `limit` string
- `multi_camera` boolean
- `name_contains` string
- `ordering` string
- `page` string

## Response `200`

- PaginatedCounterList
  - `next_page` string, nullable
  - `prev_page` string, nullable
  - `results` Counter[]
    - `id` integer, required
    - `created_date` string, date-time, required — Counter creation date
    - `modified_date` string, date-time, required — Counter modification date
    - `active` boolean
    - `name` string, required
    - `comment` string — Extended description, up to 2048 characters
    - `detect_faces` boolean — `true` if face counting enabled
    - `detect_silhouettes` boolean — `true` if silhouette counting enabled
    - `detect_cars` boolean — `true` if cars counting enabled
    - `count_interval` integer, required
    - `roi` object, nullable — ROI XY coordinates for related cameras
    - `cameras` integer[], required — Count entities from these cameras (provide either `cameras` or `camera_groups` argument)
    - `multi_camera` boolean, required — Counter is related to multiple cameras or a single camera
    - `camera_groups` integer[], required
    - `health_status` CounterStatus, required
      - `status` 'IN_PROGRESS' | 'DISABLED', required
      - `color` 'green' | 'yellow' | 'red' | 'gray', required
      - `code_desc` string, required — `Status` description for UI.
      - `statistic` object, required — Counter statistics
    - `now_faces` integer, required
    - `now_cars` integer, required
    - `now_bodies` integer, required
    - `detect_proximity` boolean — `true` if proximity detection enabled
    - `proximity_calibration_status` 1 | 2 | 3 | 4 | 5 | 6, required
    - `proximity_calibration_data_collection_end` string, date-time, required — Calibration end date
    - `overall_proximity_min` number, float, nullable, required
    - `overall_proximity_max` number, float, nullable, required
    - `overall_proximity_avg` number, float, nullable, required
    - `now_proximity_min` number, float, nullable, required
    - `now_proximity_max` number, float, nullable, required
    - `now_proximity_avg` number, float, nullable, required
    - `proximity_calibration_error` string, required — Proximity calibration error description

---

[API](https://skmtc.dev/ntechlab/apis/internal-api-documentation.md) · [All operations](https://skmtc.dev/ntechlab/apis/internal-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ntechlab/internal-api-documentation/revisions/fe217a895bc7/schema)