View as Markdown
Booking Experts icon

Booking Experts ACTION

List Amenities

List amenities from BookingExperts. 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 Amenities 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-amenities",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    booking_experts: { authProvisionId: "apn_xxxxxxx" },
    page: 10,
    perPage: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Amenities inputs
Property Type Description
page Page integer
Page number
Optional
perPage Per Page integer
Number of items per page
Optional
sort Sort string
Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order
Optional
fields Fields string
Specify a comma separated list of attributes to return
Optional
include Include string
Specify a comma separated list of resources to include
Optional
name Name string
Filter by name
Optional
type Type string
Filter by type
Optional
position Position string
Filter by position
Optional
semanticAmenityType Semantic Amenity Type string
Filter by semantic amenity type
Optional
amenityGroup Amenity Group ID string
Filter by amenity group
Optional Dynamic
amenityOptions Amenity Options string
Filter on amenity_options. Specify a comma separated list of IDs to filter on.
Optional
filters Filters object
Additional query params to filter amenities. Example: filter[name]=Wifi. If a key overlaps with an explicit filter prop, the value provided here will override it.
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-amenities
Version
1.0.1
App
Booking Experts
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes