Retrieve multiple active connections

Connections API

Retrieve multiple active connections

Request

List all active connections you have with properties.

You can filter the results by when connection types were activated, and by the connection types a connection includes or is missing. Results are paginated. To navigate between pages, use the meta.next_page and meta.prev_page URLs in the response.

Security

BearerAuth

Query

start_timestring, (date-time)

Only include connections with at least one connection type activated on or after this date and time (UTC). Format: YYYY-MM-DDThh:mm:ssZ.

Example:start_time=2018-10-10T12:34:56Z

end_timestring, (date-time)

Only include connections with at least one connection type activated before this date and time (UTC). Format: YYYY-MM-DDThh:mm:ssZ.

Example:end_time=2018-10-10T12:34:56Z

connection_typeArray of strings, unique

Only include connections containing all of the specified connection types. To specify multiple connection types, repeat the parameter, for example connection_type=PHOTOS&connection_type=CONTENT. A comma-separated list is not supported.

Items Enum:"RESERVATIONS""AVAILABILITY""REVIEWS""CONTENT""PHOTOS""MESSAGING""PROMOTIONS""PERFORMANCE""FACILITIES""PROPERTY_SETTINGS"

missing_connection_typeArray of strings, unique

Only include connections not containing any of the specified connection types. To specify multiple connection types, repeat the parameter, for example missing_connection_type=PHOTOS&missing_connection_type=CONTENT. A comma-separated list is not supported.

Items Enum:"RESERVATIONS""AVAILABILITY""REVIEWS""CONTENT""PHOTOS""MESSAGING""PROMOTIONS""PERFORMANCE""FACILITIES""PROPERTY_SETTINGS"

page_sizeinteger, (int32), [ 1 .. 100 ]

Maximum number of items to return per page.

Default:10

cursorstring

Opaque cursor for fetching the next or previous page. To paginate, use the full URL from meta.next_page or meta.prev_page directly rather than extracting the cursor value.

order_bystring

Sort order for results. Format: field_name asc or field_name desc. Supported fields: connected_at and last_connected_at. The sort direction defaults to asc and can be omitted. To sort by both fields, separate them with a comma, for example last_connected_at desc, connected_at asc.

Default:"connected_at asc"

curl -i -X GET \
  'https://developers.booking.com/_mock/connectivity/docs/openapispecs/connections-api/connections-api-specification/properties/-/connections?start_time=2018-10-10T12%3A34%3A56Z&end_time=2018-10-10T12%3A34%3A56Z&connection_type=RESERVATIONS&missing_connection_type=RESERVATIONS&page_size=10&cursor=string&order_by=connected_at%20asc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful operation

Headers

X-RUIDstring, (uuid)

Unique request ID. Include this value when contacting support.

Bodyapplication/json

metaobject(PaginatedResponseMeta)

warningsArray of objects(ApiError)

errorsArray of objects(ApiError)

dataArray of objects(ActiveConnection)

Response

{
  "meta": {
    "next_page": "https://supply-xml.booking.com/connections-api/properties/-/connections?page_size=10&order_by=connected_at%20desc&cursor=AAAAAACrQTAAAAAAAGSgHXA",
    "prev_count": 0,
    "next_count": 1023,
    "ruid": "fee464e7-1b41-4834-b665-b2aeba62ba7d"
  },
  "warnings": [],
  "errors": [],
  "data": [
    { … }
  ]
}