# Reservation groups

## Get all reservation groups

Returns all reservation groups, filtered by unique identifiers and other filters. Note this operation uses [Pagination](/connector-api/guidelines/pagination.md) and supports [Portfolio Access Tokens](/connector-api/concepts/multi-property.md).

### Request

`[PlatformAddress]/api/connector/v1/reservationGroups/getAll`

```javascript
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "EnterpriseIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ],
  "ReservationGroupIds": [
    "fe795f96-0b64-445b-89ed-c032563f2bac"
  ],
  "UpdatedUtc": {
    "StartUtc": "2023-04-27T11:48:57Z",
    "EndUtc": "2023-04-27T11:48:57Z"
  },
  "Limitation": {
    "Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7",
    "Count": 100
  }
}
```

| Property              | Type                                                                 | Contract                      | Description                                                                                                                               |
| --------------------- | -------------------------------------------------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `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.                                                                                               |
| `EnterpriseIds`       | array of string                                                      | optional, max 1000 items      | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| `ReservationGroupIds` | array of string                                                      | optional, max 1000 items      | Unique identifiers of the `ReservationGroup`. Required if no other filter is provided.                                                    |
| `UpdatedUtc`          | [Time interval](/connector-api/operations/_objects.md#time-interval) | optional, max length 3 months | Interval in which the `ReservationGroup` was updated. Required if no other filter is provided.                                            |
| `Limitation`          | [Limitation](/connector-api/guidelines/pagination.md#limitation)     | required                      | Limitation on the quantity of data returned and optional Cursor for the starting point of data.                                           |

### Response

```javascript
{
  "ReservationGroups": [
    {
      "Id": "769fc613-838f-41a7-ac2a-aff100c3189f",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "Name": "Mr and Mrs smith wedding",
      "ChannelManager": "2023-04-27T11:48:57Z",
      "ChannelManagerGroupNumber": "152fg645-834f-63a7-he6a-vsy845c4753a"
    }
  ],
  "Cursor": "723jd664-235f-36a4-tg6d-gfy850c645f"
}
```

| Property            | Type                                             | Contract                 | Description                                                                                                                                                                              |
| ------------------- | ------------------------------------------------ | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ReservationGroups` | array of [Reservation Group](#reservation-group) | required, max 1000 items | The filtered reservation groups.                                                                                                                                                         |
| `Cursor`            | string                                           | optional                 | Unique identifier of the last and hence oldest reservation group returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of older reservation groups. |

#### Reservation Group

| Property                    | Type   | Contract | Description                                                                |
| --------------------------- | ------ | -------- | -------------------------------------------------------------------------- |
| `Id`                        | string | required | Unique identifier of the reservation group.                                |
| `Name`                      | string | optional | Name of the reservation group, might be empty or same for multiple groups. |
| `ChannelManager`            | string | optional | Name of the corresponding channel manager.                                 |
| `ChannelManagerGroupNumber` | string | optional | Identifier of the channel manager.                                         |
| `EnterpriseId`              | string | required | Unique identifier of the `Enterprise` the reservation group belongs to.    |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mews.com/connector-api/operations/reservationgroups.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
