---
title: "Gets all rules"
method: GET
path: "/rules/v4"
tags: ["Rules"]
---

# Gets all rules

`GET /rules/v4`

Gets all rules definitions.

## Query parameters

- `pageToken` string
- `limit` integer

## Response `200`

Response body contains an array of rule objects, `count` indicates the number of returned rules,
and `pageToken` is the next page token if available.

If no rules are found, an object with an empty data array is returned.

- object
  - `count` integer, required — Number of items returned in the response
  - `items` object[], required
    - `rule` union, required
      - object
        - `description` string — Rule description
        - `name` string — Rule name
        - `threshold` object, required — Utilization event is triggered when the asset starts moving indicating that the asset is utilized, and also when the asset stops moving and has been stationary for longer than the threshold duration indicating that the asset is unutilized.
          - `durationS` integer, required — Duration in seconds
        - `type` 'utilization', required — The rule type
      - object
        - `description` string — Rule description
        - `name` string — Rule name
        - `threshold` object, required — Detention event is triggered when the asset has been continuously stationary for longer than the threshold duration.
          - `durationS` integer, required — Duration in seconds
        - `type` 'detention', required — The rule type
      - object
        - `description` string — Rule description
        - `name` string — Rule name
        - `threshold` object, required — Dwelling event is triggered when the asset has been continuously inside a geofence for longer than the threshold duration.
          - `durationS` integer, required — Duration in seconds
        - `type` 'dwelling', required — The rule type
      - object
        - `description` string — Rule description
        - `geofenceId` string, uuid, required — Geofence ID
        - `name` string — Rule name
        - `threshold` object, required
          - `maxVolume` integer — A maximum volume of stock
          - `minVolume` integer — A minimum volume of stock
        - `type` 'stock', required — The rule type
      - object
        - `description` string — Rule description
        - `name` string — Rule name
        - `type` 'online', required — The rule type
      - object
        - `description` string — Rule description
        - `name` string — Rule name
        - `threshold` object, required
          - `after` integer — Allowed time deviation in seconds from the planned ETD/ETA in case the shipment is behind the schedule
          - `before` integer — Allowed time deviation in seconds from the planned ETD/ETA in case the shipment is ahead of schedule
        - `type` 'shipmentSchedule', required — The rule type
    - `ruleId` string, uuid, required — Must be a valid UUIDv4.
  - `limit` integer, required — Maximum number of items as specified in request
  - `nextPageToken` string — Token to fetch the next page (if exists)

## Other responses

- `400` — Bad request The request object is in an incorrect format or has values that are invalid or out of range. If available, further error details are provided in the response body.
- `401` — Unauthorized The request did not provide correct authentication details
- `403` — Forbidden The account does not have the correct privileges

---

[API](https://skmtc.net/here/apis/tracking.md) · [All operations](https://skmtc.net/here/apis/tracking/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/here/tracking/revisions/efa162f7023c/schema)