--- title: "Get all companionships" method: POST path: "/api/connector/v1/companionships/getAll" tags: ["Companionships"] --- # Get all companionships `POST /api/connector/v1/companionships/getAll` Returns all companionships based on customers, reservations or reservation groups. One of them must be specified in the request. 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 - CompanionshipFilterParameters - `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. - `CompanionshipIds` string[], nullable — Unique identifiers of `Companionship`. Required if no other filter is provided. - `Extent` CompanionshipExtent, required - `Reservations` boolean, nullable — Whether the response should contain reservations. - `ReservationGroups` boolean, nullable — Whether the response should contain reservation groups. - `Customers` boolean, nullable — Whether the response should contain customers. - `ReservationIds` string[], nullable — Unique identifiers of `Reservation`. Required if no other filter is provided. - `CustomerIds` string[], nullable — Unique identifiers of `Customer`. Required if no other filter is provided. - `ReservationGroupIds` string[], nullable — Unique identifiers of `ReservationGroup`. Required if no other filter is provided. - `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 ## Response `200` OK - CompanionshipResult - `Companionships` Companionship[], nullable — Companionships. - `Id` string, uuid — Unique identifier of `Companionship`. - `CustomerId` string, uuid — Unique identifier of Customer. - `ReservationGroupId` string, uuid — Unique identifier of ReservationGroup. - `ReservationId` string, uuid, nullable — Unique identifier of reservation. - `Reservations` ReservationOld[], nullable — The accompanied reservations. - `Id` string, uuid, required — Unique identifier of the reservation. - `ServiceId` string, uuid, required — Unique identifier of the Service that is reserved. - `GroupId` string, uuid, required — Unique identifier of the Reservation group. - `Number` string, required — Confirmation number of the reservation in Mews. - `ChannelNumber` string, nullable — Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number). - `ChannelManagerNumber` string, nullable — Unique number of the reservation within the reservation group. - `ChannelManagerGroupNumber` string, nullable — Number of the reservation group within a Channel manager that transferred the reservation from Channel to Mews. - `ChannelManager` string, nullable — Name of the Channel manager (e.g. AvailPro, SiteMinder, TravelClick, etc). - `State` 'Enquired' | 'Confirmed' | 'Started' | 'Processed' | 'Canceled' | 'Optional' | 'Requested', required - `Origin` 'Distributor' | 'ChannelManager' | 'Import' | 'Connector' | 'Navigator' | 'CommanderInPerson' | 'CommanderChannel' | 'CommanderPhone' | 'CommanderEmail' | 'CommanderWebsite' | 'CommanderMessage' | 'CommanderCallCenter' | 'CommanderRoomingList', required - `OriginDetails` string, nullable — Details about the reservation origin. - `Purpose` 'Leisure' | 'Business' | 'Student' - `CreatedUtc` string, required — Creation date and time of the reservation in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, required — Last update date and time of the reservation in UTC timezone in ISO 8601 format. - `CancelledUtc` string, nullable — Cancellation date and time in UTC timezone in ISO 8601 format. - `StartUtc` string, required — Start of the reservation in UTC timezone in ISO 8601 format. This is either the scheduled reservation start time, or the actual customer check-in time if this is earlier than the scheduled start time. - `EndUtc` string, required — End of the reservation (departure) in UTC timezone in ISO 8601 format. - `ReleasedUtc` string, nullable — Date when the optional reservation is released in UTC timezone in ISO 8601 format. - `RequestedCategoryId` string, uuid, required — Identifier of the requested Resource category. - `AssignedSpaceId` string, uuid, nullable — Identifier of the assigned Space. - `AssignedSpaceLocked` boolean — Whether the reservation is locked to the assigned Space and cannot be moved. - `AssignedResourceId` string, uuid, nullable — Identifier of the assigned Resource. - `AssignedResourceLocked` boolean, required — Whether the reservation is locked to the assigned Resource and cannot be moved. - `BusinessSegmentId` string, uuid, nullable — Identifier of the reservation Business segment. - `CompanyId` string, uuid, nullable — Identifier of the Company on behalf of which the reservation was made. - `TravelAgencyId` string, uuid, nullable — Identifier of the Company that mediated the reservation. - `AvailabilityBlockId` string, uuid, nullable — Unique identifier of the Availability block the reservation is assigned to. - `RateId` string, uuid, required — Identifier of the reservation Rate. - `VoucherId` string, uuid, nullable — Unique identifier of the Voucher that has been used to create reservation. - `CreditCardId` string, uuid, nullable — Unique identifier of the Credit card. - `CancellationReason` 'Other' | 'ConfirmationMissed' | 'BookedElsewhere' | 'ForceMajeure' | 'GuestComplaint' | 'NoShow' | 'PriceTooHigh' | 'ServiceNotAvailable' | 'InputError' | 'InvalidPayment' | 'TravelAgency' | 'RequestedByGuest' | 'Update' | 'BookingAbandoned' | 'RequestedByBooker' - `AdultCount` integer — Count of adults the reservation was booked for. - `ChildCount` integer — Count of children the reservation was booked for. - `PersonCounts` ReservationPersonCount[], required — Number of people per age category the reservation was booked for. - `AgeCategoryId` string, uuid, required — Unique identifier of the [Age category](https://mews-systems.gitbook.io/connector-api/operations/agecategories#age-category). - `Count` integer, required — Number of people of a given age category. Only positive value is accepted. - `OwnerId` string, uuid, required — Unique identifier of the Customer or Company who owns the reservation. - `CustomerId` string, uuid, required — Unique identifier of the Customer who owns the reservation. - `BookerId` string, uuid, nullable — Unique identifier of the Customer on whose behalf the reservation was made. - `CompanionIds` string[], required — Unique identifiers of the `Customer`s that will use the resource. - `ChannelManagerId` string, nullable — Channel Manager number. - `Options` ReservationOptions, required - `OwnerCheckedIn` boolean, required — Owner of the reservation checked in. - `AllCompanionsCheckedIn` boolean, required — All companions of the reservation checked in. - `AnyCompanionCheckedIn` boolean, required — Any companion of the reservation checked in. - `ReservationGroups` ReservationGroupOld[], nullable — The accompanied reservation groups. - `Id` string, uuid — Unique identifier of the reservation group. - `Name` string, nullable — Name of the reservation group. - `Customers` Customer[], nullable — Customers that belong to the companionships. - `Id` string, uuid, required — Unique identifier of the customer. - `ChainId` string, uuid, required — Unique identifier of the chain. - `Number` string, required — Unique number of the customer (max 19 digits). - `Title` 'Mister' | 'Miss' | 'Misses' — Type of the title prefix of the customer. Note that the value should not be used as-is, but localized. For example, the value `Misses` should be displayed as `Mrs.` in English and `Fr.` in German. Mister (Mr.) Miss (Ms.) Misses (Mrs.) - `CustomTitleName` string, nullable — Name of the customer's custom title, as configured in the chain's guest titles. Mutually exclusive with `Title`. - `Sex` 'Male' | 'Female' — Male Female - `FirstName` string, nullable — First name of the customer. - `LastName` string, required — Last name of the customer. - `SecondLastName` string, nullable — Second last name of the customer. - `NationalityCode` string, nullable — ISO 3166-1 code of the [Country](https://mews-systems.gitbook.io/connector-api/operations/countries/#country). - `PreferredLanguageCode` string, nullable — Language and culture code of the customer's preferred language, according to their profile. For example: `en-GB`, `fr-CA`. - `LanguageCode` string, nullable — Language and culture code of the customer's language, based on multiple sources. These sources include the preferred language specified in internal data based on previous bookings, and the preferred language of the customer specified in their profile. If neither of these sources are present, we use the native language based on the customer's nationality. The format is, for example, `en-US` or `fr-FR`. - `BirthDate` string, nullable — Date of birth in ISO 8601 format. - `BirthCountryCode` string, nullable — ISO 3166-1 alpha-2 code of the birth country. - `BirthCountrySubdivisionCode` string, nullable — ISO 3166-2 code of the administrative division, e.g. ES-C. - `BirthPlace` string, nullable — Place of birth. - `Occupation` string, nullable — Occupation of the customer. - `Email` string, nullable — Email address of the customer. - `HasOtaEmail` boolean — Whether the customer's email address is a temporary email address from an OTA. For more details, see the [product documentation](https://help.mews.com/s/article/how-to-maintain-ota-guest-profiles-with-verified-email-addresses-obtained-from-the-guest-portal). - `Phone` string, nullable — Phone number of the customer (possibly mobile). - `TaxIdentificationNumber` string, nullable — Tax identification number of the customer. - `LoyaltyCode` string, nullable — Loyalty code of the customer. - `AccountingCode` string, nullable — Accounting code of the customer. - `BillingCode` string, nullable — Billing code of the customer. - `Notes` string, nullable — Internal notes about the customer. - `CarRegistrationNumber` string, nullable — Registration number of the customer's car. - `DietaryRequirements` string, nullable — Customer's dietary requirements, e.g. Vegan, Halal. - `CreatedUtc` string, date-time, required — Creation date and time of the customer in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the customer in UTC timezone in ISO 8601 format. - `Passport` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `IdentityCard` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `Visa` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `DriversLicense` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `Address` OldAddress - `Id` string, uuid — Unique identifier of the address. - `Line1` string, nullable — First line of the address. - `Line2` string, nullable — Second line of the address. - `City` string, nullable — The city. - `PostalCode` string, nullable — Postal code. - `CountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `CountrySubdivisionCode` string, nullable — ISO 3166-2 code of the administrative division, e.g. `DE-BW`. - `Latitude` number, double, nullable — The latitude. - `Longitude` number, double, nullable — The longitude. - `AddressId` string, uuid, nullable — Unique identifier of the `Address` of the customer. - `Classifications` CustomerClassificationEnum[], required — Classifications of the customer. - `Options` CustomerOptionsEnum[], required — Options of the customer. - `ItalianDestinationCode` string, nullable — Value of Italian destination code. - `ItalianFiscalCode` string, nullable — Value of Italian fiscal code. - `ItalianLotteryCode` string, nullable — Italian lottery code. - `CompanyId` string, uuid, nullable — Unique identifier of [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) the customer is associated with. - `MergeTargetId` string, uuid, nullable — Unique identifier of the account ([Customer](https://mews-systems.gitbook.io/connector-api/operations/#customer)) to which this customer is linked. - `ActivityState` string, nullable — [Activity State](https://mews-systems.gitbook.io/connector-api/operations/#activity-state) of customer record, i.e. whether active or deleted. - `IsActive` boolean, required — Whether the customer record is still active. - `PreferredSpaceFeatures` ResourceFeatureClassification[], required — A list of room preferences, such as view type, bed type, and amenities. - `CreatorProfileId` string, uuid, required — Unique identifier of the user who created the customer. - `UpdaterProfileId` string, uuid, required — Unique identifier of the user who last updated the customer. - `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)