View as Markdown
Booking Experts icon

Booking Experts ACTION

List Guests

List all guests for a reservation. 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 Guests 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-guests",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    booking_experts: { authProvisionId: "apn_xxxxxxx" },
    administrationId: "Administration ID",
    reservationId: "Reservation ID",
  },
})

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 Guests inputs
Property Type Description
administrationId Administration ID string
The ID of the administration
Required Dynamic
reservationId Reservation ID string
The ID of a reservation
Required Dynamic
fields Fields string
Specify a comma separated list of attributes to return
Optional
sort Sort string
Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order
Optional
page Page integer
Page number
Optional
perPage Per Page integer
Number of items per page
Optional
id Guest ID string
The ID of a guest
Optional Dynamic
firstName First Name string
Filter by first name
Optional
lastName Last Name string
Filter by last name
Optional
email Email string
Filter by email
Optional
phone Phone string
Filter by phone
Optional
gender Gender string
Filter by gender
Optional
countryCode Country Code string
Filter by country code
Optional
dateOfBirth Date of Birth string
Filter by date of birth
Optional
address Address string
Filter by address
Optional
city City string
Filter by city
Optional
postalCode Postal Code string
Filter by postal code
Optional
province Province string
Filter by province
Optional
municipality Municipality string
Filter by municipality
Optional
documentType Document Type string
Filter by document type
Optional
documentNumber Document Number string
Filter by document number
Optional
documentIssueDate Document Issue Date string
Filter by document issue date
Optional
visaNumber Visa Number string
Filter by visa number
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-guests
Version
0.0.3
App
Booking Experts
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes