---
title: "Get all restrictions"
method: POST
path: "/api/connector/v1/restrictions/getAll"
tags: ["Restrictions"]
---

# Get all restrictions

`POST /api/connector/v1/restrictions/getAll`

Returns all restrictions of the default service provided by the enterprise.
Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).

## Request body

- RestrictionFilterParameters
  - `ClientToken` string, required — Token identifying the client application.
  - `AccessToken` string, required — Access token of the client application.
  - `Client` string, required — Name and version of the client application.
  - `Limitation` Limitation, required — Limitation on the quantity of data returned.
    - `Count` integer, required
    - `Cursor` string, uuid, nullable
  - `EnterpriseIds` string[], nullable — Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
  - `TimeFilter` string, nullable
  - `StartUtc` string, nullable
  - `EndUtc` string, nullable
  - `CollidingUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted.
    - `StartUtc` string, date-time, nullable
    - `EndUtc` string, date-time, nullable
  - `CreatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted.
    - `StartUtc` string, date-time, nullable
    - `EndUtc` string, date-time, nullable
  - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted.
    - `StartUtc` string, date-time, nullable
    - `EndUtc` string, date-time, nullable
  - `RestrictionIds` string[], nullable — Unique identifiers of the `Restriction`.
  - `ResourceCategoryIds` string[], nullable — Unique identifiers of `Resource category`.
  - `RateIds` string[], nullable — Unique identifiers of `Rate`. Returns all restrictions that affect the given rates, i.e. ones without any `Restriction Conditions`, ones assigned directly to specified rates, ones assigned to `Rate group` of specified rates, or ones inherited from base rates.`.
  - `ExactRateIds` string[], nullable — Unique identifiers of `Rate`. Returns only those restrictions which have matching `ExactRateId` set in `Restriction Condition`.
  - `BaseRateIds` string[], nullable — Unique identifiers of `Rate`. Returns only those restrictions which have matching `BaseRateId` set in `Restriction Condition`.
  - `Origin` 'User' | 'Integration'
  - `ServiceIds` string[], required — Unique identifiers of the `Service` from which the restrictions are requested.

## Response `200`

OK

- RestrictionResult
  - `Restrictions` Restriction[], required — Restrictions of the default service.
    - `Id` string, uuid, required — Unique identifier of the restriction.
    - `ServiceId` string, uuid, required — Unique identifier of the `Service`.
    - `ExternalIdentifier` string, nullable — External identifier of the restriction.
    - `Origin` 'User' | 'Integration', required — User (Restriction was created by a user in Mews.) Integration (Restriction was created by a 3rd-party integration.)
    - `Conditions` RestrictionConditions, required — The conditions or rules that must be met by a reservation for the restriction to apply.
      - `Type` 'Stay' | 'Start' | 'End', required — Stay (Guests can't stay within specified dates.) Start (Guests can't check in within specified dates.) End (Guests can't check out within specified dates.)
      - `ExactRateId` string, uuid, nullable — Unique identifier of the restricted exact `Rate`.
      - `BaseRateId` string, uuid, nullable — Unique identifier of the restricted base `Rate`.
      - `RateGroupId` string, uuid, nullable — Unique identifier of the restricted `Rate group`.
      - `ResourceCategoryId` string, uuid, nullable — Unique identifier of the restricted `Resource category`.
      - `ResourceCategoryType` 'Room' | 'Bed' | 'Dorm' | 'Apartment' | 'Suite' | 'Villa' | 'Site' | 'Office' | 'MeetingRoom' | 'ParkingSpot' | 'Desk' | 'TeamArea' | 'Membership' | 'Tent' | 'CaravanOrRV' | 'UnequippedCampsite' | 'Bike' | 'ExtraBed' | 'Cot' | 'Crib' | 'ConferenceRoom' | 'Rooftop' | 'Garden' | 'Restaurant' | 'Amphitheater' | 'PrivateSpaces' — Type of the category. Room Bed Dorm Apartment Suite Villa Site Office MeetingRoom ParkingSpot Desk TeamArea Membership Tent CaravanOrRV UnequippedCampsite Bike ExtraBed Cot Crib ConferenceRoom Rooftop Garden Restaurant Amphitheater PrivateSpaces
      - `StartUtc` string, nullable — Start date of the restriction time interval, specified in ISO 8601 format and adjusted to UTC - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes) for important information on format and implementation.
      - `EndUtc` string, nullable — End date of the restriction time interval, specified in ISO 8601 format and adjusted to UTC - see [Datetimes](https://mews-systems.gitbook.io/connector-api/guidelines/serialization#datetimes) for important information on format and implementation.
      - `Days` string[], nullable — The restricted days of week. Defaults to all days when not provided. Ignored when the service uses a time unit longer than a day.
      - `Hours` Hours
        - `Zero` boolean, required — Hour 0 enabled
        - `One` boolean, required — Hour 1 enabled
        - `Two` boolean, required — Hour 2 enabled
        - `Three` boolean, required — Hour 3 enabled
        - `Four` boolean, required — Hour 4 enabled
        - `Five` boolean, required — Hour 5 enabled
        - `Six` boolean, required — Hour 6 enabled
        - `Seven` boolean, required — Hour 7 enabled
        - `Eight` boolean, required — Hour 8 enabled
        - `Nine` boolean, required — Hour 9 enabled
        - `Ten` boolean, required — Hour 10 enabled
        - `Eleven` boolean, required — Hour 11 enabled
        - `Twelve` boolean, required — Hour 12 enabled
        - `Thirteen` boolean, required — Hour 13 enabled
        - `Fourteen` boolean, required — Hour 14 enabled
        - `Fifteen` boolean, required — Hour 15 enabled
        - `Sixteen` boolean, required — Hour 16 enabled
        - `Seventeen` boolean, required — Hour 17 enabled
        - `Eighteen` boolean, required — Hour 18 enabled
        - `Nineteen` boolean, required — Hour 19 enabled
        - `Twenty` boolean, required — Hour 20 enabled
        - `TwentyOne` boolean, required — Hour 21 enabled
        - `TwentyTwo` boolean, required — Hour 22 enabled
        - `TwentyThree` boolean, required — Hour 23 enabled
    - `Exceptions` RestrictionExceptions — The rules that prevent the restriction from applying to a reservation, even when all conditions have been met.
      - `MinAdvance` string, nullable — The minimum time before the reservation starts, you can reserve in ISO 8601 duration format.
      - `MaxAdvance` string, nullable — The maximum time before the reservation starts, you can reserve in ISO 8601 duration format.
      - `MinLength` string, nullable — Minimal reservation length in ISO 8601 duration format.
      - `MaxLength` string, nullable — Maximal reservation length in ISO 8601 duration format.
      - `MinPrice` CurrencyValueOld — Total price of the reservation.
        - `Currency` string, currency, required
        - `Value` number, double, nullable
        - `Net` number, double, nullable
        - `Tax` number, double, nullable
        - `TaxRate` number, double, nullable
      - `MaxPrice` CurrencyValueOld — Total price of the reservation.
        - `Currency` string, currency, required
        - `Value` number, double, nullable
        - `Net` number, double, nullable
        - `Tax` number, double, nullable
        - `TaxRate` number, double, nullable
  - `Cursor` string, uuid, nullable — Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

## Other responses

- `204` — Server has successfully fulfilled the request and there is no additional information to send back.
- `400` — Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
- `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
- `403` — Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
- `408` — Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
- `429` — Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
- `500` — Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api).

---

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