canonical: https://jentic.com/apis/portersetup.com/portersetup

# Porter Setup API

Jentic publishes the only available OpenAPI specification for Porter Setup API, keeping it validated and agent-ready. Porter Setup API enables hospitality and event businesses to manage guest bookings programmatically. It provides endpoints for creating reservations with check-in and check-out dates, retrieving booking lists filtered by status or date range, and accessing individual guest profiles with contact information.

## For AI agents

Create and retrieve hospitality bookings and guest profiles for event venues and accommodation providers.

## Scope

Does not handle payments, room inventory management, or housekeeping schedules - use for guest booking and profile retrieval only.

## Capabilities

- Schedule guest bookings with specified check-in and check-out dates
- Filter booking lists by status or date range for occupancy planning
- Retrieve guest contact details for communication follow-ups
- Track booking status changes across the reservation lifecycle
- Look up individual reservation details by booking identifier

## Use cases

### Automated Reservation Creation

Create guest bookings from external channels such as email confirmations, chatbot conversations, or third-party booking platforms. The Porter Setup API accepts guest name, email, phone, check-in date, check-out date, guest count, and room type, returning a booking ID and status confirmation within a single API call.

Example prompt: Create a booking for guest John Smith checking in 2026-07-01 and checking out 2026-07-03 for 2 guests in a standard room

### Occupancy Monitoring and Reporting

Retrieve filtered lists of bookings to monitor venue occupancy, generate reports on upcoming arrivals, and identify gaps in scheduling. The API supports filtering by booking status and date range, allowing property managers to get a real-time view of their reservation pipeline without manual lookups.

Example prompt: List all bookings with status confirmed that have a check-in date from 2026-07-01 onwards

### Guest Communication Workflows

Access guest profiles to retrieve email addresses and phone numbers for pre-arrival messaging, post-stay feedback requests, or loyalty program outreach. Agents can combine guest data with booking details to personalize communications based on stay duration and room type.

Example prompt: Retrieve the guest profile for guest_id gst_12345 and extract their email address for a check-in reminder

### AI Agent Booking Management via Jentic

AI agents use Jentic to discover and call Porter Setup API operations by intent, without reading documentation. An agent searching for 'create a hospitality booking' receives the exact operation schema, input parameters, and authentication requirements, then executes the booking creation in a single step.

Example prompt: Search Jentic for 'create a hospitality booking', load the operation schema, and execute a booking for guest Jane Doe from 2026-08-10 to 2026-08-12

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/bookings` | Create a new guest booking |
| GET | `/bookings` | List bookings with optional status and date filters |
| GET | `/bookings/{booking_id}` | Retrieve a specific booking by ID |
| GET | `/guests/{guest_id}` | Get guest contact information |

## Key resources

- **Bookings** — Create, list, and retrieve guest reservations with dates and status tracking
- **Guests** — Access guest profiles including name, email, and phone

## Why Jentic

- **Setup:** Wiring the Porter Setup API by hand means handling its API key auth and formatting booking and guest requests yourself. Through Jentic you install once, import the Porter Setup API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Porter Setup puts the booking and guest ids in the URL path (`/bookings/{booking_id}`, `/guests/{guest_id}`), so a rule can pin your agent to reading a specific booking or guest: you choose the operations it may call, so creating bookings is not included unless you add it.
- **Credential handling:** Your Porter Setup API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a hospitality booking' or 'look up a guest', and Jentic returns the matching Porter Setup operation with its full input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Booking.com API** — Large-scale accommodation booking platform with broader inventory
- **Cloudbeds API** — Full hospitality management platform with PMS, channel management, and revenue tools
- **Calendly API** — Scheduling platform for coordinating event times and availability

## FAQ

### Why is there no official OpenAPI spec for Porter Setup API?

Porter Setup does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Porter Setup API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Porter Setup API use?

The Porter Setup API uses API key authentication. Through Jentic, the API key is stored in the encrypted credential vault and agents receive scoped access without handling raw keys directly.

### Can I filter bookings by date range with the Porter Setup API?

Yes. The list bookings endpoint accepts a date_from query parameter to filter bookings starting from a specific date. You can also filter by status to narrow results to confirmed, pending, or cancelled reservations.

### What are the rate limits for the Porter Setup API?

Rate limit details are not specified in the Porter Setup API documentation. Contact Porter Setup support for current limits. When using Jentic, rate limiting and retry logic are handled automatically.

### How do I create a booking through the Porter Setup API with Jentic?

Install the Jentic SDK with pip install jentic, then search for 'create a hospitality booking'. Jentic returns the createBooking operation schema requiring guest_name, check_in, and check_out fields. Execute the call with your booking details and receive a booking_id confirmation.

### What data does the guest profile endpoint return?

The guest profile endpoint at `/guests/{guest_id}` returns the guest's ID, name, email address, and phone number. This allows agents to retrieve contact details for follow-up communications without storing personal data locally.

### Can I limit what my agent is allowed to do with the Porter Setup API?

Yes. Because you run Jentic One yourself, your own rules decide which Porter Setup operations and credentials the agent may use. Porter Setup puts booking and guest IDs in the URL path (`/bookings/{booking_id}`, `/guests/{guest_id}`), so you can pin the agent to reading a specific booking or guest profile. You choose the operations it may call, so creating bookings is not included unless you explicitly add it.