# Companionships

## Get all companionships

Returns all companionships based on customers, reservations or reservation groups. One of them must be specified in the request. 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/companionships/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"
  ],
  "CompanionshipIds": [
    "72d4b117-1f84-44a3-1f84-8b2c0635ac60"
  ],
  "CustomerIds": [
    "35d4b117-4e60-44a3-9580-c582117eff98"
  ],
  "ReservationIds": [
    "bfee2c44-1f84-4326-a862-5289598f6e2d"
  ],
  "ReservationGroupIds": [
    "c704dff3-7811-4af7-a3a0-7b2b0635ac59"
  ],
  "UpdatedUtc": {
    "StartUtc": "2020-02-05T00:00:00Z",
    "EndUtc": "2020-02-10T00:00:00Z"
  },
  "Limitation": {
    "Count": 10
  }
}
```

| 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.                                     |
| `CompanionshipIds`    | array of string                                                      | optional, max 1000 items      | Unique identifiers of `Companionship`. Required if no other filter is provided.                                                                                               |
| `Extent`              | [Companionship extent](#companionship-extent)                        | required                      | Extent of data to be returned. E.g. it is possible to specify that together with the companionships, customers, reservations, and reservation groups should be also returned. |
| `ReservationIds`      | array of string                                                      | optional, max 1000 items      | Unique identifiers of `Reservation`. Required if no other filter is provided.                                                                                                 |
| `CustomerIds`         | array of string                                                      | optional, max 1000 items      | Unique identifiers of `Customer`. Required if no other filter is provided.                                                                                                    |
| `ReservationGroupIds` | array of string                                                      | optional, max 1000 items      | Unique identifiers of `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 `Companionship` was updated. Must be used together with at least one another filter.                                                                    |
| `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.                                                                               |

#### Companionship extent

| Property            | Type    | Contract | Description                                             |
| ------------------- | ------- | -------- | ------------------------------------------------------- |
| `Reservations`      | boolean | optional | Whether the response should contain reservations.       |
| `ReservationGroups` | boolean | optional | Whether the response should contain reservation groups. |
| `Customers`         | boolean | optional | Whether the response should contain customers.          |

### Response

```javascript
{
  "Companionships": [
    {
      "Id": "72d4b117-1f84-44a3-1f84-8b2c0635ac60",
      "CustomerId": "35d4b117-4e60-44a3-9580-c582117eff98",
      "ReservationGroupId": "c704dff3-7811-4af7-a3a0-7b2b0635ac59",
      "ReservationId": "bfee2c44-1f84-4326-a862-5289598f6e2d"
    }
  ],
  "Customers": null,
  "Reservations": null,
  "ReservationGroups": null,
  "Cursor": "72d4b117-1f84-44a3-1f84-8b2c0635ac60"
}
```

| Property            | Type                                                                                                                        | Contract | Description                                                                                                                                                                        |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Companionships`    | array of [Companionship](#companionship)                                                                                    | optional | Companionships.                                                                                                                                                                    |
| `Reservations`      | array of [Reservation (ver 2017-04-12)](/connector-api/operations/reservations.md#reservation-ver-2017-04-12)               | optional | The accompanied reservations.                                                                                                                                                      |
| `ReservationGroups` | array of [Reservation groups (ver 2017-04-12)](/connector-api/operations/reservations.md#reservation-groups-ver-2017-04-12) | optional | The accompanied reservation groups.                                                                                                                                                |
| `Customers`         | array of [Customer](/connector-api/operations/customers.md#customer)                                                        | optional | Customers that belong to the companionships.                                                                                                                                       |
| `Cursor`            | string                                                                                                                      | optional | 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. |

#### Companionship

| Property             | Type   | Contract | Description                            |
| -------------------- | ------ | -------- | -------------------------------------- |
| `Id`                 | string | required | Unique identifier of `Companionship`.  |
| `CustomerId`         | string | required | Unique identifier of Customer.         |
| `ReservationGroupId` | string | required | Unique identifier of ReservationGroup. |
| `ReservationId`      | string | optional | Unique identifier of reservation.      |


---

# 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/companionships.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.