Dispatch4

Dispatches_Documents5

Dispatches_Routes2

Geofence11

Map-Data_Road-Editor8

Map-Data_Road-Editor_Areas1

Map-Data_Road-Segment1

Optimization4

Places5

Places_Geocoding5

Places_Multi-Geocode5

Routing12

Tracking_Asset11

Tracking_Monitor5

Tracking_Namespace2

Tracking_Search4

Tracking_Subscribe1

Tracking_Trip6

Tracking_Webhook3

Map-Data_Road-Editor

Get the paginated list of restrictions

get/restrictions/list

Query parameters

transformboolean

a internal parameter

source'rrt' | 'pbf'

It represents where it comes from, currently the possible values include "rrt", "xsm"

Specify the type of restrictions to fetch.

status'active' | 'inactive'

Example:status=inactive

Restrictions can be active or inactive at a given time by virtue of their nature. For example, maximum speed limits can be active on the roads leading to schools during school hours and be inactive afterwards or certain road closure restrictions be active during holidays/concerts and be inactive otherwise.

Use this parameter to filter the restrictions based on their status at the time of making the request i.e. whether they are in force or not.

state'enabled' | 'disabled' | 'deleted'

Example:state=deleted

This parameter is used to filter restrictions based on their state i.e. whether the restriction is currently enabled, disabled, or deleted. For example, users can retrieve a list of all the deleted restrictions by setting state=deleted.

mode'0w' | '2w' | '3w' | '4w' | '6w'

Specify the modes of travel that the restriction pertains to.

areastring required

Specify the area name. It represents a region where restrictions can be applied.

The area it belongs to. See Area API

namestring

The name of the restriction. This should be same as that provided while creating or updating the restriction.

limitinteger required

The number of restrictions to be returned in the response. Please note that if the limit is set to a number more than the total number of available restrictions, then all restrictions would be returned together.

offsetinteger required

An integer value indicating the number of items in the collection that need to be skipped in the response. Please note that the offset starts from 0, so the first item returned in the result would be the item at (offset + 1) position in collection.

Users can use offset along with limit to implement paginated result.

keystring 32 character alphanumeric string required

Example:key=API_KEY

A key is a unique identifier that is required to authenticate a request to the API.

Response

Example response

{
  "data": [
    {
      "bbox": {
        "minLat": 0,
        "minLon": 0,
        "maxLat": 1,
        "maxLon": 1
      },
      "repeat_on": "Mo-Fr 07:00-09:00,17:00-19:00"
    }
  ]
}

Changes

Changed in 3 of the 15 revisions of this API.4848

Jul 31, 20257ee76f0ff6791616See the full diff
- ▲
  removed the enum value 0w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 2w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 3w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 4w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 6w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value active from the query request parameter status
  request-parameter-enum-value-removed
- ▲
  removed the enum value closure from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value deleted from the query request parameter state
  request-parameter-enum-value-removed
- ▲
  removed the enum value disabled from the query request parameter state
  request-parameter-enum-value-removed
- ▲
  removed the enum value enabled from the query request parameter state
  request-parameter-enum-value-removed
- ▲
  removed the enum value fixedspeed from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value inactive from the query request parameter status
  request-parameter-enum-value-removed
- ▲
  removed the enum value maxspeed from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value parking from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value truck from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value turn from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ○
  added the new enum value 0w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 2w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 3w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 4w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 6w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value active to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value closure to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value deleted to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value disabled to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value enabled to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value fixedspeed to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value inactive to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value maxspeed to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value parking to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value truck to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value turn to the query request parameter restriction_type
  request-parameter-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 2025a800b73f11c11616See the full diff
- ▲
  removed the enum value 0w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 2w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 3w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 4w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 6w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value active from the query request parameter status
  request-parameter-enum-value-removed
- ▲
  removed the enum value closure from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value deleted from the query request parameter state
  request-parameter-enum-value-removed
- ▲
  removed the enum value disabled from the query request parameter state
  request-parameter-enum-value-removed
- ▲
  removed the enum value enabled from the query request parameter state
  request-parameter-enum-value-removed
- ▲
  removed the enum value fixedspeed from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value inactive from the query request parameter status
  request-parameter-enum-value-removed
- ▲
  removed the enum value maxspeed from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value parking from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value truck from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value turn from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ○
  added the new enum value 0w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 2w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 3w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 4w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 6w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value active to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value closure to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value deleted to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value disabled to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value enabled to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value fixedspeed to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value inactive to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value maxspeed to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value parking to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value truck to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value turn to the query request parameter restriction_type
  request-parameter-enum-value-added
Jul 30, 2025b79d96775b131616See the full diff
- ▲
  removed the enum value 0w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 2w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 3w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 4w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value 6w from the query request parameter mode
  request-parameter-enum-value-removed
- ▲
  removed the enum value active from the query request parameter status
  request-parameter-enum-value-removed
- ▲
  removed the enum value closure from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value deleted from the query request parameter state
  request-parameter-enum-value-removed
- ▲
  removed the enum value disabled from the query request parameter state
  request-parameter-enum-value-removed
- ▲
  removed the enum value enabled from the query request parameter state
  request-parameter-enum-value-removed
- ▲
  removed the enum value fixedspeed from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value inactive from the query request parameter status
  request-parameter-enum-value-removed
- ▲
  removed the enum value maxspeed from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value parking from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value truck from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ▲
  removed the enum value turn from the query request parameter restriction_type
  request-parameter-enum-value-removed
- ○
  added the new enum value 0w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 2w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 3w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 4w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value 6w to the query request parameter mode
  request-parameter-enum-value-added
- ○
  added the new enum value active to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value closure to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value deleted to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value disabled to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value enabled to the query request parameter state
  request-parameter-enum-value-added
- ○
  added the new enum value fixedspeed to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value inactive to the query request parameter status
  request-parameter-enum-value-added
- ○
  added the new enum value maxspeed to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value parking to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value truck to the query request parameter restriction_type
  request-parameter-enum-value-added
- ○
  added the new enum value turn to the query request parameter restriction_type
  request-parameter-enum-value-added

Full history