ProhostAI API — Developer Portal

Developer portal · MCP setup

Connect your AI assistant to your properties.

Welcome AI agents — connect ProhostAI to Claude Desktop, Claude Code, OpenAI Codex, or any MCP-compatible client over OAuth 2.1 or API key.

💡 New to ProhostAI? Sign up and connect your listings first — MCP setup assumes you have an account with listings imported.

Recommended — OAuth (one command, sign in through your browser, no API key to manage):

            shell
claude mcp add --transport http prohostai https://connect.prohost.ai/mcp
        

Claude Code discovers OAuth via our .well-known/oauth-protected-resource metadata and walks you through sign-in. It identifies itself with a stable client identity (a client-ID metadata document), so once you have approved it you stay signed in — a new machine, container, or reinstall reuses the same approval instead of asking you to consent again.

Alternative — API key (for headless, CI, and agent-fleet setups where no browser sign-in is possible, or for long-lived pinned keys). Add to .mcp.json in your project root:

            json
{
  "mcpServers": {
    "prohostai": {
      "command": "npx",
      "args": ["-y", "@prohostai/mcp-server"],
      "env": {
        "PROHOST_API_KEY": "ph_live_YOUR_KEY"
      }
    }
  }
}
        

⚡ Try asking: "What reservations check in today?" or "Create a task to fix the AC at Beachfront Villa."

Available Tools 283 tools

add_cleaning_checklist_item

Add a new item to a cleaning checklist.

add_cleaning_comment

Add a comment on a cleaning.

add_place_tag

Attach a listing tag to a place (idempotent).

add_pricing_override

Upsert a single date-specific price override on PriceLabs.

admin_create_customer_feedback

Internal ProhostAI staff only — cross-account admin tool.

admin_get_customer_feedback

Internal ProhostAI staff only — cross-account admin tool.

admin_get_llm_trace

Internal ProhostAI staff only — cross-account admin tool.

admin_merge_customer_feedback

Internal ProhostAI staff only — cross-account admin tool.

admin_search_activity_logs

Internal ProhostAI staff only — cross-account admin tool.

admin_search_audit_logs

Internal ProhostAI staff only — cross-account admin tool.

admin_search_customer_feedback

Internal ProhostAI staff only — cross-account admin tool.

admin_search_llm_traces

Internal ProhostAI staff only — cross-account admin tool.

admin_update_customer_feedback

Internal ProhostAI staff only — cross-account admin tool.

approve_approval_request

Approve a pending approval request that an external agent filed, on behalf of the account owner/admin you a…

ask_ai_question

Ask ProhostAI's Ask AI assistant a question about this account (properties, reservations, guests, operation…

assign_cleaning

Assign or unassign the primary cleaner on a cleaning.

assign_conversation

Set who owns one or more conversations.

block_dates

Block (mark unavailable) a list of dates on a listing's calendar.

bulk_assign_listing_tags

Assign every tag in ``tag_ids`` to every listing in ``listing_ids``.

bulk_create_tasks

Create many tasks in ONE call, each optionally with its own subtasks.

bulk_delete_expenses

Delete multiple expenses by ID.

bulk_remove_listing_tags

Remove every tag in ``tag_ids`` from every listing in ``listing_ids``.

bulk_update_conversations

Apply the same patch (e.g.

bulk_update_expenses

Update a common set of fields across multiple expenses in one call.

cancel_scheduled_message

Cancel a scheduled message that has not yet been sent.

check_missing_custom_fields

For a set of field keys, return which listings (under a tag or an explicit ID list) don't have a value for…

classify_bank_transaction

AI-suggest the best expense category for a Plaid bank transaction.

classify_ramp_transaction

AI-suggest the best expense category for a Ramp corporate-card transaction.

community_create_post

Post into a community lounge as the acting user's pseudonymous community profile.

community_list_lounges

List every community lounge with the acting user's standing in each: slug, name, kind, emoji, member count,…

configure_ai_employee

Update an existing AI employee.

create_ai_employee

Create a brand-new custom AI employee (not from a template).

create_ai_employee_trigger

Wire an event trigger to an AI employee.

create_approval_request

File an approval request for a proposed action that needs human sign-off — use this BEFORE performing anyth…

create_cleaning

Schedule a new cleaning job for a listing.

create_cleaning_checklist

Create a new checklist on a cleaning.

create_contact

Create a new contact record on the account.

create_expense_category

Create a new custom expense category for the account.

create_expense_from_ramp_transaction

Create an expense from a Ramp corporate-card transaction and reconcile the transaction onto it.

create_expense_from_transaction

Create an expense from a Plaid bank transaction and reconcile the transaction onto it.

create_guest

Create a new guest record on the account.

create_guidebook

Create a new guidebook attached to a listing.

create_guidebook_section

Create a guidebook-scoped section.

create_listing

Create a new manual property listing.

create_listing_tag

Create a new listing tag on the account.

create_memory

Create a new memory in the property knowledge base.

create_message_template

Create a message template.

create_owner

Create a new property owner on the account.

create_owner_statement

Create a new owner statement covering ``[from_date, to_date]``.

create_place

Create a new place on the account.

create_recurring_task

Create a recurring-task SCHEDULE that automatically generates task instances on a cadence (weekly, monthly,…

create_saved_reply

Create a saved reply (canned message).

create_suggestion

Create an AI message-suggestion draft on a guest conversation.

create_tag_section

Create a tag-scoped section.

create_task

Create a new task.

create_task_checklist

Create a checklist on a task.

create_task_checklist_from_template

Instantiate a task checklist from a template.

create_upgrade_option

Create a paid upgrade option attached to a guidebook.

create_webhook_subscription

Create a webhook subscription.

create_workflow

Propose a NEW automation workflow.

crm_add_comment

Add a comment/note to a CRM object (opportunity, contact, company, or meeting).

crm_archive_opportunity

Archive (soft-delete) a CRM opportunity.

crm_create_company

Create a CRM company (an organization).

crm_create_contact

Create a CRM contact (a person).

crm_create_field_definition

Define a new CRM custom field (e.g.

crm_create_followup

Create a follow-up task tied to a CRM opportunity.

crm_create_opportunity

Create a CRM opportunity (a deal card) on a pipeline.

crm_get_opportunity

Fetch a single CRM opportunity by id.

crm_list_companies

List or search CRM companies (organizations) for the account.

crm_list_contacts

List or search CRM contacts (people) for the account.

crm_list_field_definitions

List the account's CRM custom-field definitions, optionally filtered by object type.

crm_list_opportunities

List or search CRM opportunities (deal cards) for the account.

crm_list_pipelines

List the account's CRM pipelines with their ordered stages.

crm_log_meeting

Log (or book) a CRM meeting / call against a deal, contact, or company.

crm_move_opportunity

Move a CRM opportunity to a different stage (auto-closes on won/lost stages).

crm_set_custom_field

Set a custom field by key on a CRM object.

crm_update_opportunity

Update fields on an existing CRM opportunity.

delete_ai_employee

Permanently delete a custom AI employee.

delete_ai_employee_trigger

Remove an AI employee's event trigger.

delete_cleaning_attachment

Delete an attachment on a cleaning.

delete_cleaning_checklist

Delete a checklist on a cleaning.

delete_cleaning_checklist_item

Delete a cleaning checklist item.

delete_cleaning_comment

Delete a cleaning comment (author only).

delete_contact

Delete a contact.

delete_contact_custom_fields

Remove the named keys from ``custom_fields`` on every contact in ``contact_ids``.

delete_expense_category

Delete a custom expense category.

delete_guest_custom_fields

Remove the named keys from ``custom_fields`` on every guest in ``guest_ids``.

delete_guidebook_section

Delete a guidebook-scoped section.

delete_listing_custom_fields

Batch-delete custom-field keys from listings, a tag, or the account.

delete_listing_tag

Delete a listing tag and all of its assignments.

delete_memory

Move a memory to the trash by ID.

delete_message_template

Soft-delete a message template by ID.

delete_owner_statement

Delete an owner statement.

delete_pin

Delete a pin.

delete_place

Delete a place; cascades to pins and tag associations.

delete_pricing_override

Delete one or more date-specific price overrides from PriceLabs.

delete_reservation_custom_fields

Remove the named keys from ``custom_fields`` on every reservation in ``reservation_ids``.

delete_saved_reply

Soft-delete a saved reply by ID.

delete_tag_section

Move a tag-scoped section (and its sub-sections) to the trash.

delete_task_checklist

Delete a checklist on a task.

delete_upgrade_option

Delete an upgrade option.

delete_workflow

Delete an automation workflow.

docs_append_section

Append a new heading-titled section to a doc.

docs_read

Read a Drive document by path or id.

docs_read_section

Read a single section of a doc by heading text.

docs_write

Replace a Drive document body.

docs_write_section

Replace a section's body.

draft_reply

Generate a non-persisting AI reply draft for a conversation.

drive_create

Create a Drive item (folder/doc/sheet).

drive_delete

Soft-delete a Drive item by path or id.

drive_get

Fetch a single Drive item by path or id.

drive_list

List children of a Drive folder by path.

drive_move

Move a Drive item to a new parent (by path).

drive_search

Search Drive items by name (case-insensitive substring).

edit_cleaning_comment

Edit a previously-posted cleaning comment (author only).

edit_message

Edit the body of a previously-sent message.

get_ai_chat_messages

Read the message history of one of this credential's Ask AI chat sessions, oldest first.

get_ai_employee_replies

Poll your 1:1 DM with an AI employee for messages, oldest first.

get_approval_request

Get one approval request by id, including its current status (pending / approved / rejected / expired), who…

get_autopilot_schedule

Read the account's autopilot schedule windows — the per-weekday time ranges during which autopilot may auto…

get_autopilot_settings

Read the account's autopilot (automated-messaging) configuration: the master switch, message delay, confide…

get_availability

Get calendar availability for a listing over a date range.

get_bank_accounts

List bank/credit-card accounts connected via Plaid for the current account.

get_contact_custom_fields

Return the resolved custom-field values for a contact, with provenance.

get_conversation_messages

Get messages for a conversation.

get_dashboard_summary

Get a composite dashboard summary: today's check-ins/outs, pending tasks, and inbox counts.

get_earnings_summary

Get an earnings summary for a date range.

get_guest_custom_fields

Return the resolved custom-field values for a guest, with provenance.

get_guidebook

Get guidebook content for a listing.

get_listing

Get a single listing by id, including title, address, capacity, and timezone.

get_listing_channel_urls

Return deterministic OTA URLs for a listing.

get_listing_custom_fields

Resolve the merged custom-field dict for a listing using the ``account → tag → source → listing`` precedence.

get_listing_customizations

Return a listing's PriceLabs pricing customizations — standing lead-time / rule-based settings, NOT per-dat…

get_listing_group

Get the parent/child relationships for a listing group.

get_listing_pricing

Return the current min/base/max for a listing on PriceLabs.

get_notification_settings

Get the acting user's complete notification preferences for the selected account: every scope array, the fu…

get_owner

Get full details for a single owner by ID.

get_owner_statement

Get a single owner statement by ID.

get_owner_statement_expenses

Return expense totals for the statement window, broken down per listing.

get_owner_statement_rental_activity

Return rental-activity totals for the statement window: per-reservation and per-listing breakdowns plus agg…

get_place

Get a single place by ID.

get_plaid_connection_status

Get the Plaid bank connection(s) (Items) for the current account: institution, status (active / login_requi…

get_pricelabs_listings_mapping

Return the PriceLabs ↔ ProhostAI listing mapping.

get_pricing_neighborhood

Return PriceLabs neighborhood pricing data for a listing.

get_pricing_rate_plans

Return rate plans configured on PriceLabs for the listing.

get_pricing_recommendations

Return PriceLabs recommended prices for a listing.

get_property_knowledge

Get all memories (property knowledge) for a listing, grouped by scope.

get_ramp_cards

List corporate cards connected via Ramp for the current account.

get_ramp_connection_status

Get the Ramp connection(s) for the current account: connected business, status (active / error / disconnect…

get_reservation

Get full details for a single reservation by ID.

get_reservation_custom_fields

Return the resolved custom-field values for a reservation, with provenance.

get_workflow

Get one workflow's full definition (steps + trigger config) plus a summary of its most recent executions.

google_places_autocomplete

Server-side proxy to Google Places Autocomplete (v1).

google_places_details

Server-side proxy to Google Places Details (v1).

hire_ai_employee

Hire (activate) one of the pre-built template AI employees — a launch-lineup template (pre-seeded inert on…

leave_internal_note

Leave a team-only internal note on a conversation.

link_conversation_to_reservation

Link a conversation to a reservation so the thread carries that stay's context (inbox attribution, AI groun…

link_ramp_transaction_to_expense

Link a Ramp corporate-card transaction to an existing expense for reconciliation.

link_transaction_to_expense

Link a bank transaction to an existing expense for reconciliation.

list_ai_chat_sessions

List this credential's Ask AI chat sessions, newest first.

list_ai_employee_triggers

List the event triggers wired to an AI employee.

list_ai_employees

List the AI employees on the account, with each one's activation state.

list_approval_requests

List approval requests on this account, newest first.

list_cleaning_attachments

List uploaded attachments on a cleaning.

list_cleaning_checklists

List all checklists on a cleaning, with their items.

list_conversation_message_variables

List valid placeholders for conversation scheduled messages and message templates.

list_expense_categories

List expense categories for the account.

list_guidebook_pins

List pins for a guidebook plus tag-scoped pins inherited via the guidebook's listing tags.

list_guidebook_sections

List the guidebook-scoped sections of a guidebook.

list_listing_photos

List the photos attached to a listing, ordered by the ``order`` field.

list_listing_tags

List all listing tags on the account, optionally filtered by tag_type.

list_listings

List all listings (properties) for the account.

list_message_templates

List all message templates on the account.

list_owner_statements

List owner statements for the account, optionally filtered by status, owner, or title search.

list_place_tags

List the listing tags attached to a place.

list_places

List the account's places with optional filters (tag, category, text search).

list_pricing_overrides

List date-specific price overrides currently set on PriceLabs for the listing.

list_recurring_tasks

List the account's recurring-task schedules (the templates that auto-generate tasks on a cadence), newest f…

list_saved_replies

List all saved replies on the account.

list_scheduled_messages

List scheduled messages on a conversation, optionally filtered by status.

list_skills

List the account's skill library (host playbooks): named, reusable procedure packs the AI follows for speci…

list_suggestions

List AI suggestions / drafts for a conversation, newest first.

list_task_checklists

List all checklists on a task.

list_upgrade_options

List the upgrade options attached to a guidebook.

list_webhook_subscriptions

List active webhook subscriptions for the account.

list_workflows

List automation workflows on the account.

load_skill

Load one skill (host playbook) by key and return its full body — the host's standing instructions for that…

mark_conversation_read

Mark a conversation's messages as read for the API user.

message_ai_employee

Send a message to one of the account's AI employees in your 1:1 DM thread and dispatch them to work on it.

move_pin_scope

Move a pin between guidebook scope and tag scope.

move_section_scope

Move a section between guidebook-scoped and tag-scoped storage.

pause_ai

Pause AI replies on a conversation (mutes the AI for non-@mentions).

pin_place_to_guidebook

Pin a place to a guidebook (guidebook-scoped pin).

pin_place_to_tag

Pin a place to a listing tag (tag-scoped pin).

publish_review_reply

Publish a previously-generated AI-authored review reply (an 'auto-review') to the upstream OTA.

publish_suggestion

Send the suggestion text (or its edited override) as a host message on the conversation.

reject_approval_request

Reject a pending approval request that an external agent filed, on behalf of the account owner/admin you ar…

remove_place_tag

Detach a listing tag from a place.

reorder_guidebook_pins

Bulk-update positions of guidebook-scoped pins.

reorder_guidebook_sections

Bulk-reorder guidebook-scoped sections.

reorder_tag_pins

Bulk-update positions of tag-scoped pins.

reorder_tag_sections

Bulk-reorder tag-scoped sections.

reorder_task_checklists

Reorder checklists on a task.

report_cleaning_issue

Report a new issue on a cleaning.

resolve_cleaning_issue

Delete (resolve) a cleaning issue.

resume_ai

Resume AI replies on a conversation that was previously paused.

revise_suggestion

Stage a host instruction on an AI suggestion so the next agent run can pick it up.

revoke_conversation_share

Revoke the public share link on a conversation.

run_workflow

Manually trigger a workflow run now.

schedule_message

Schedule a host message to be sent at a future time.

search_bank_transactions

Search bank/credit-card transactions from Plaid-connected accounts.

search_cleanings

Search cleanings.

search_contacts

Search contacts by name, email, company, or role.

search_conversations

Search conversations with optional inbox-status filters.

search_expenses

Search expenses.

search_guests

Search and filter guests by name, email, or listing.

search_memories

Search the property knowledge base.

search_owners

Search owners/investors.

search_ramp_transactions

Search corporate-card transactions from Ramp-connected accounts.

search_reservations

Search and filter reservations.

search_reviews

Search guest reviews.

search_tasks

Search tasks.

send_message

Send a message in a conversation through the real delivery pipeline.

set_contact_custom_fields

Merge ``fields`` into ``custom_fields`` on every contact in ``contact_ids``.

set_guest_custom_fields

Merge ``fields`` into ``custom_fields`` on every guest in ``guest_ids``.

set_listing_custom_fields

Batch-set custom fields on listings, a tag, or the account.

set_listing_group_children

Replace the child-listings list for a parent listing (a 'listing group').

set_listing_host_role

Set the host role (owner / cohost) for a Hospitable-connected listing.

set_mystay_section_order

Set the order of sections shown on the My Stay tab of the guidebook.

set_reservation_custom_fields

Merge ``fields`` into ``custom_fields`` on every reservation in ``reservation_ids``.

share_conversation

Create (or refresh) a public 'anyone with the link' share link for ONE conversation and return its URL.

sheets_delete_row

Delete a row from a sheet by row id.

sheets_get

Fetch sheet metadata (row_count, schema) by path or id.

sheets_insert_rows

Bulk-insert rows into a sheet.

sheets_list

List sheets in the account.

sheets_query

Filter rows via a simple {column_id: value} equality DSL (like read_rows without sort).

sheets_read_rows

Read rows from a sheet.

sheets_schema

Fetch a sheet's column schema by path or id.

sheets_update_row

Partial-patch a row in a sheet by row id.

submit_feedback

Submit a bug report, feature request, or question to the ProhostAI team.

toggle_reaction

Add or remove the API user's reaction with this emoji on a message.

toggle_workflow

Enable (resume) or disable (pause) a workflow.

translate_task_checklist

Translate a task checklist to a target language.

unblock_dates

Unblock (mark available) a list of dates on a listing's calendar.

unlink_conversation_from_reservation

Remove the link between a conversation and a reservation (e.g.

update_ai_employee_trigger

Update an AI employee's event trigger.

update_autopilot_schedule

Replace the account's autopilot schedule windows.

update_autopilot_settings

Partially update the account's autopilot configuration.

update_calendar_days

Update price, availability, and/or minimum-stay for a listing's calendar.

update_cleaning_checklist

Update a checklist on a cleaning.

update_cleaning_checklist_item

Update fields on a cleaning checklist item (title, completion, photo, etc.).

update_cleaning_issue

Update the title of a cleaning issue.

update_cleaning_status

Transition a cleaning to a new status.

update_contact

Update an existing contact.

update_expense

Update fields on an existing expense.

update_expense_category

Rename an expense category.

update_guest

Update an existing guest.

update_guidebook

Patch fields on a guidebook (title, description, theme, branding).

update_guidebook_section

Patch fields on a guidebook-scoped section.

update_last_minute_pricing

Configure PriceLabs last-minute (lead-time based) pricing for a listing — the ``last_minute_prices`` custom…

update_listing

Update fields on a listing — title, description, address, capacity, wifi, custom_fields, etc.

update_listing_photos

Replace the photo set for a listing.

update_listing_pricing

Push min/base/max to PriceLabs for the listing.

update_listing_tag

Update one or more fields on an existing listing tag.

update_memory

Update an existing memory.

update_message_template

Update a message template by ID.

update_notification_settings

Update the acting user's notification preferences.

update_owner

Update an existing owner.

update_owner_statement

Update an existing owner statement.

update_pin

Update a pin's category, position, or host note override.

update_place

Patch fields on an existing place.

update_reservation

Update a public-safe subset of fields on a reservation: ``custom_fields`` (full replace) and guest contact…

update_saved_reply

Update fields on a saved reply.

update_scheduled_message

Edit the body and/or send time of a scheduled message that hasn't been sent.

update_tag_section

Patch fields on a tag-scoped section.

update_task

Update a task's status, priority, description, or other fields.

update_task_checklist

Update fields on a task checklist.

update_upgrade_option

Patch fields on an existing upgrade option.

update_workflow

Update an existing automation workflow in place.

upload_cleaning_attachment

Register one or more attachment URLs on a cleaning.

upload_contact_photo

Generate a presigned S3 PUT URL for a contact's photo.

upload_guidebook_image

Return a presigned PUT URL for uploading a guidebook image to S3.

upload_place_photo

Return a presigned PUT URL for uploading a place photo to S3.

Data & privacy

Tool calls only ever touch data the authenticated account can already see in ProhostAI. OAuth scopes and listing-scoped API keys are enforced on every call. See our privacy policy for what we collect, how long we retain it, and how to request deletion.