---
title: "Get service availability (ver 2024-01-22)"
method: POST
path: "/api/connector/v1/services/getAvailability/2024-01-22"
tags: ["Services"]
---

# Get service availability (ver 2024-01-22)

`POST /api/connector/v1/services/getAvailability/2024-01-22`

## Request

- Base URL: `https://api.mews.com`
- URL: `https://api.mews.com/api/connector/v1/services/getAvailability/2024-01-22`
- Auth: none declared

Returns selected availability and occupancy metrics of a bookable service for a specified time interval, similar to [the availability & occupancy report](https://help.mews.com/s/article/Availability-Occupancy-report). Availability will be returned for all service time units that the specified time interval intersects. So, for example, an interval `1st Jan 23:00 UTC - 1st Jan 23:00 UTC` will result in one time unit for `2nd Jan`, while Interval `1st Jan 23:00 UTC - 2nd Jan 23:00 UTC` will result in two time units for `2nd Jan` and `3rd Jan` (assuming a time unit period of "Day"). UTC timestamps must correspond to the start boundary of a time unit, e.g. 00:00 converted to UTC for a time unit of "Day". Other timestamps are not permitted. The __maximum size of time interval__ depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months. For more information about time units, see [Time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units).

## Request body

- ServiceAvailabilityFilterParametersV20240122
  - `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.
  - `ServiceId` string, uuid, required: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service) whose availability should be returned.
  - `FirstTimeUnitStartUtc` string, date-time, required: Start of the time interval, expressed as the timestamp for the start of the first [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format.
  - `LastTimeUnitStartUtc` string, date-time, required: End of the time interval, expressed as the timestamp for the start of the last [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/), in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/): 367 hours if hours, 367 days if days, or 60 months if months.
  - `Metrics` ResourceAvailabilityMetricTypeEnum[], required: Set of [Service availability metrics](https://mews-systems.gitbook.io/connector-api/operations/services/#service-availability-metrics) to be returned.

## Response `200`

OK

- ServiceAvailabilityResultV20240122
  - `TimeUnitStartsUtc` string[], required: Set of all time units covered by the time interval; expressed in UTC timezone ISO 8601 format.
  - `ResourceCategoryAvailabilities` ResourceCategoryAvailabilityV20240122[], required: Resource category availabilities. Can be empty if no resource categories are assigned to the service.
    - `ResourceCategoryId` string, uuid, required: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/resources#resource-category).
    - `Metrics` object, required: Dictionary keys are names of [Service availability metrics](https://mews-systems.gitbook.io/connector-api/operations/services#service-availability-metrics), values are arrays of integers with metric values for corresponding time unit in `TimeUnitStartsUtc`.
      - `OutOfOrderBlocks` integer[]
      - `PublicAvailabilityAdjustment` integer[]
      - `OtherServiceReservationCount` integer[]
      - `Occupied` integer[]
      - `ConfirmedReservations` integer[]
      - `OptionalReservations` integer[]
      - `BlockAvailability` integer[]
      - `AllocatedBlockAvailability` integer[]
      - `UsableResources` integer[]
      - `ActiveResources` integer[]
      - `HouseUse` integer[]

## 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.dev/mews/apis/connector-api.md) - [All operations](https://skmtc.dev/mews/apis/connector-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mews/apis/connector-api/revisions/d02162631aaa?raw)