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

# List areas

`GET /areas/`

This method retrieves the list of areas.

## Query parameters

- `camera_groups` integer[]
- `cameras` 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
- `enabled` boolean
- `id_in` integer[]
- `limit` string
- `multi_camera` boolean
- `name_contains` string
- `ordering` string
- `page` string

## Response `200`

- PaginatedAreaList
  - `next_page` string, nullable
  - `prev_page` string, nullable
  - `results` Area[]
    - `id` integer, required
    - `created_date` string, date-time, required — Area creation date
    - `modified_date` string, date-time, required — Area modification date
    - `name` string, required — Area name, up to 256 characters
    - `enabled` boolean — `true` if the area is enabled
    - `trigger_count_gt` integer, nullable — `gt` people on a frame are required for trigger activation
    - `trigger_count_lt` integer, nullable — `lt` people on a frame are required for trigger activation
    - `trigger_time` integer, required — Minimum time in seconds conditions should be met to activate triggers
    - `trigger_calendar` Calendar[], nullable — Area activation calendar during which an area trigger can activate. Area trigger might remain active beyond calendar intervals if the trigger activation condition is still satisfied
      - `weekdays` WeekdaysEnum[], required
      - `start_at` string, required — Time in format `HH:MM` in `UTC`
      - `end_at` string, required — Time in format `HH:MM` in `UTC`
    - `camera_roi` AreaCameraLink[], required
      - `roi` array[], nullable — ROI points XY coordinates. *Example*: `[[0, 1000], [1000, 1000], [1000, 0], [0, 0]]`
        - integer[]
      - `camera` integer, required
    - `scheduled_now` boolean, required
    - `camera_groups` integer[], required
    - `cameras` integer[], required — Monitor area for these cameras
    - `multi_camera` boolean, required

---

[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)