GUguesty
Promotions Open Api

Get promotion listings

Get listing IDs assigned to a promotion.

get/rm-promotions/promotions/{promotionId}/listings

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/rm-promotions/promotions/{promotionId}/listings
  • Auth
    API key in header authorization

Path parameters

promotionIdstring required
Example:63ee4b7e459ca31532f

The promotion ID.

Query parameters

includeChildrenboolean required
Example:true

Include children listings.

Response

Returns listing IDs assigned to the promotion.

promotionIdstring required

ID of promotion.

listingIdsstring[] required

Listing IDs assigned to the promotion.

limitnumber required

Maximum number of promotions that can be returned in the response.

skipnumber required

Number of promotions that should be skipped from the result set.

countnumber required

Number of listings in the result set.

requestIdstring required

ID of request.

Example response

{
  "promotionId": "63ee4b7e459ca31532f",
  "listingIds": [
    "63ee4b7e459ca31532f",
    "63ee4b7e459ca31532f"
  ],
  "limit": 10,
  "count": 10,
  "requestId": "123e4567-e89b-12d3-a456-426614174000"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.