Booking Experts ACTION
List Availabilities
List availabilities of a channel you have access to. See the documentation
- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Booking Experts account once, then configure and run List Availabilities from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "booking_experts-list-availabilities",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
booking_experts: { authProvisionId: "apn_xxxxxxx" },
fields: ["Fields"],
include: ["Include"],
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "booking_experts-list-availabilities",
"configured_props": {
"booking_experts": { "authProvisionId": "apn_xxxxxxx" },
"fields": ["Fields"],
"include": ["Include"]
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "booking_experts",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "booking_experts-list-availabilities",
arguments: {
fields: ["Fields"],
include: ["Include"],
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
fields Fields | string[] | Fieldset of attributes to return. See the documentation Optional |
include Include | string[] | Includes list of resources to include. See the documentation Optional |
channelIds Channel IDs | string[] | Specify a list of channel IDs to be used for searching availability. By default, all accessible channels associated to your app will be used. Overriding this may be useful when you have access to multiple channels of the same administration. Optional Dynamic |
includeSemanticSegmentCounts Include Semantic Segment Counts | boolean | When true, the amount of results per semantic segment will be added to the metadata Optional |
includeAmenityCounts Include Amenity Counts | boolean | When true, the amount of results per amenity will be added to the metadata Optional |
referrer Referrer | string | Referrer name. Optional |
startDate Start Date | string | Filter on start date. Expects a date range. Note: date ranges have an exclusive end date. Format: YYYY-MM-DD..YYYY-MM-DD Optional |
overlapsDate Overlaps Date | string | Filter availabilities that (partially) overlap these dates. Format: YYYY-MM-DD..YYYY-MM-DD Optional |
includesDate Includes Date | string | Filter availabilities that contain the specified date range. Format: YYYY-MM-DD..YYYY-MM-DD Optional |
arrangement Arrangement | string | Filter on availabilities that exactly match the supplied date range. Format: YYYY-MM-DD..YYYY-MM-DD Optional |
los Los | string | Filter on length of stay. Format: 1..21 Optional |
wday Wday | string | Filter on a particular week day Optional |
administrationIds Administration IDs | string[] | Filter on administrations Optional Dynamic |
rentableTypeIds Rentable Type IDs | string[] | Filter on rentable types Optional |
excludeRentableTypeIds Exclude Rentable Type IDs | string[] | Exclude rentable types Optional |
rentableSegmentIds Rentable Segment IDs | string[] | Filter on rentable segments. Optional Dynamic |
excludeRentableSegmentIds Exclude Rentable Segment IDs | string[] | Exclude rentable segments. Optional Dynamic |
amenityIds Amenity IDs | string[] | Filter on amenities. Optional Dynamic |
discountCampaignId Discount Campaign ID | string | Filter on discount campaign ID. Optional Dynamic |
inventoryObjectId Inventory Object ID | string | Filter on inventory object ID. Optional Dynamic |
promotionToken Promotion Token | string | Filter on owner promotion token. Optional |
countryCodes Country Codes | string[] | Filter on country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes. For example: NL,EN,DE. Optional |
excludeCountryCodes Exclude Country Codes | string[] | Exclude country codes. Specify a comma separated list of ISO 3166-1 alpha-2 country codes. For example: NL,EN,DE. Optional |
seniors Seniors | integer | Filter on number of seniors. Optional |
adults Adults | integer | Filter on number of adults. Optional |
adolescents Adolescents | integer | Filter on number of adolescents. Optional |
children Children | integer | Filter on number of children. Optional |
babies Babies | integer | Filter on number of babies. Optional |
pets Pets | integer | Filter on number of pets. Optional |
price Price | string | Filter on a price range. Format: 100..200 Optional |
currency Currency | string | Filter on a specific ISO 4217 currency code. By default the prices are returned in the administration's native currency. Results can differ per currency Optional |
numberOfBedrooms Number of Bedrooms | integer | Filter on type number of bedrooms. Optional |
numberOfBeds Number of Beds | integer | Filter on type number of beds. Optional |
numberOfShowers Number of Showers | integer | Filter on type number of showers. Optional |
numberOfToilets Number of Toilets | integer | Filter on type number of toilets. Optional |
numberOfBathrooms Number of Bathrooms | integer | Filter on type number of bathrooms. Optional |
numberOfParkingSpots Number of Parking Spots | integer | Filter on type number of parking spots. Optional |
numberOfChildBeds Number of Child Beds | integer | Filter on type number of beds. Optional |
numberOfChildChairs Number of Child Chairs | integer | Filter on type number of child chairs. Optional |
sorters Sorters | string[] | Specify a comma separated list of sorters to apply Optional |
losDesc Los Desc | boolean | Boolean specifying the sort direction for the los sorter. When unspecified, ascending order is implied. Optional |
losDistanceDesc Los Distance Desc | boolean | Boolean specifying the sort direction for the los_distance sorter. When unspecified, ascending order is implied. Optional |
losDistanceLos Los Distance Los | integer | Length of stay for the los_distance sorter. Optional |
startDateDesc Start Date Desc | boolean | Boolean specifying the sort direction for the start_date sorter. When unspecified, ascending order is implied. Optional |
startDateDistanceDesc Start Date Distance Desc | boolean | Boolean specifying the sort direction for the start_date_distance sorter. When unspecified, ascending order is implied. Optional |
startDateDistanceStartDate Start Date Distance Start Date | string | Start date for the start_date_distance sorter. Format: YYYY-MM-DD Optional |
arrangementDistanceDesc Arrangement Distance Desc | boolean | Boolean specifying the sort direction for the arrangement_distance sorter. When unspecified, ascending order is implied. Optional |
arrangementDistanceArrangement Arrangement Distance Arrangement | string | Arrangement for the arrangement_distance sorter. Format: YYYY-MM-DD..YYYY-MM-DD Optional |
maxGuestsDesc Max Guests Desc | boolean | Boolean specifying the sort direction for the max_guests sorter. When unspecified, ascending order is implied. Optional |
highlightedDesc Highlighted Desc | boolean | Boolean specifying the sort direction for the highlighted sorter. When unspecified, ascending order is implied. Optional |
allInAmountDesc All In Amount Desc | boolean | Boolean specifying the sort direction for the all_in_amount sorter. When unspecified, ascending order is implied. Optional |
amenityIdsMatchScoreDesc Amenity Ids Match Score Desc | boolean | Boolean specifying the sort direction for the amenity_ids_match_score sorter. When unspecified, ascending order is implied. Optional |
amenityIdsMatchScoreAmenityIds Amenity Ids Match Score Amenity Ids | string[] | Amenity IDs for the amenity_ids_match_score sorter. Optional |
avgScoreDesc Avg Score Desc | boolean | Boolean specifying the sort direction for the avg_score sorter. When unspecified, ascending order is implied. Optional |
limit Limit | string | Specify a limiter here. Optional |
availabilitiesLimit Availabilities Limit | integer | Return limit availabilities. Optional |
startDatesLimit Start Dates Limit | integer | Limit to the limit best arrival dates. Optional |
startDatesAvailabilities Start Dates Availabilities | integer | Number of availabilities to return. Optional |
losLimit Los Limit | integer | Limit to the limit best Length of stay (LOS) values. Optional |
losAvailabilities Los Availabilities | integer | Number of availabilities to return. Optional |
categoriesOffset Categories Offset | integer | Result offset for the categories limiter, useful for pagination. Optional |
categoriesAvailabilities Categories Availabilities | integer | Number of availabilities to return. Optional |
rentableTypesLimit Rentable Types Limit | integer | Limit to the limit best types. Optional |
rentableTypesOffset Rentable Types Offset | integer | Result offset for the rentable_types limiter, useful for pagination. Optional |
rentableTypesAvailabilities Rentable Types Availabilities | integer | Number of availabilities to return. Optional |
administrationsLimit Administrations Limit | integer | Limit to the limit best administrations. Optional |
administrationsRentableTypes Administrations Rentable Types | integer | Limit to the limit best types. Optional |
administrationsAvailabilities Administrations Availabilities | integer | Number of availabilities to return. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- booking_experts-list-availabilities
- Version
- 1.0.2
- App
- Booking Experts
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗