---
title: "Get the paginated list of restrictions"
method: GET
path: "/restrictions/list"
tags: ["Map-Data_Road-Editor"]
---

# Get the paginated list of restrictions

`GET /restrictions/list`

## Query parameters

- `transform` boolean
- `source` 'rrt' | 'pbf'
- `restriction_type` 'turn' | 'parking' | 'fixedspeed' | 'maxspeed' | 'closure' | 'truck'
- `status` 'active' | 'inactive'
- `state` 'enabled' | 'disabled' | 'deleted'
- `mode` '0w' | '2w' | '3w' | '4w' | '6w'
- `area` string, required
- `name` string
- `limit` integer, required
- `offset` integer, required
- `key` string, 32 character alphanumeric string, required

## Response `200`

- Paginated
  - `data` RichGroupDtoResponse[] — An array of objects containing the details of the restrictions returned. Each object represents one restriction.
    - `id` integer — Returns the unique ID of the restriction. This ID can be used for update, delete, get operations on the restriction using the available API methods.
    - `name` string — Returns the name of the restriction. This value is same as that provided at the time of creating or updating the restriction.
    - `area` string — Returns the area to which the restriction belongs to.
    - `bbox` object — Returns the details of the bounding box containing the restriction.
    - `status` 'active' | 'inactive' — Returns the status of the restriction at the time of making the request i.e. whether the restriction is in force or not. It will have one of the following values: active or inactive. Please note that this field can not be directly influenced by the users. It will always be calculated using the start_time, end_time and repeat_on parameters.
    - `repeat_on` string — Returns the time periods during which this restriction active or repeats on. The time values follow a [given format](https://wiki.openstreetmap.org/wiki/Key:opening_hours).
    - `comment` string — Returns the comments that were provided for the restriction at the time of creating or updating the request.
    - `create_at` string, date-time — The timestamp at which the restriction was created.
    - `update_at` string, date-time — The timestamp at which the restriction was updated.
    - `start_time` number — The time when the restriction starts to be in-effect. It is a UNIX timestamp.
    - `end_time` number — The time when the restriction ceases to be in-effect. It is a UNIX timestamp.
    - `mode` string[] — Returns an array denoting all the traveling modes the restriction applies on.
    - `restriction_type` 'closure' | 'maxspeed' | 'fixedspeed' | 'parking' | 'turn' | 'truck' — Returns the type of restriction. This is the same value as provided when creating or updating the restriction.
    - `highway` string — Returns the highway information on which the restriction applies to. If no highway is impacted by the restriction, then this field is not present in the response.
    - `speed` number — Returns the fixed speed of segments. This field is not present in the response if the restriction type is not fixedspeed
    - `speed_limit` number — Returns the maximum speed of segments. This field is not present in the response if the restriction type is not maxspeed
    - `direction` 'forward' | 'backward' | 'both' — Returns the direction of travel on the segments to which the restriction applies.
    - `state` 'enabled' | 'disabled' | 'deleted' — Returns the state of the "restriction" itself - enabled, disabled or deleted. It does not denote if the restriction is actually in effect or not.
    - `geofence` object — Returns the list of coordinates representing the area that was used to apply the given restriction. The geofence returned is same as that provided while creating or updating the restriction.
  - `meta` object
    - `offset` integer — An integer value indicating the number of items in the collection that were skipped to display the current response. Please note that the offset starts from zero.
    - `limit` integer — An integer value indicating the maximum number of items retrieved per "page". This is the same number as provided for the limit parameter in input.
    - `total` integer — An integer value indicating the total number of items available in the data set.

---

[API](https://skmtc.net/nextbillion-ai/apis/one-spec-service.md) · [All operations](https://skmtc.net/nextbillion-ai/apis/one-spec-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nextbillion-ai/one-spec-service/versions/b647f1808dda/schema)