Sign in

v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
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 and supports Portfolio Access Tokens.

post/api/connector/v1/companionships/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

CompanionshipIdsstring[] nullable

Unique identifiers of Companionship. Required if no other filter is provided.

ReservationIdsstring[] nullable

Unique identifiers of Reservation. Required if no other filter is provided.

CustomerIdsstring[] nullable

Unique identifiers of Customer. Required if no other filter is provided.

ReservationGroupIdsstring[] nullable

Unique identifiers of ReservationGroup. Required if no other filter is provided.

Response

OK

Cursorstring 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.