API & Webhooks

Integrate GuestFlow with your PMS, booking tools, or custom backends.

The GuestFlow REST API lets Business plan accounts list properties, update details, manage knowledge base items, and read guest chat sessions. Outbound webhooks notify your server when properties, knowledge, or chat sessions change.

API keys and webhooks require an active Business subscription.

Open API dashboard →

Authentication

Create an API key in Dashboard → API & Webhooks, then send it as a Bearer token on every request.

Authorization: Bearer YOUR_API_KEY

Rate limit: 120 requests per minute per API key.

Base URL: https://www.guestflow.in.net/api/v1

Quick start

curl -s "https://www.guestflow.in.net/api/v1/properties" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-GuestFlow-Locale: en"

Endpoints

GEThttps://www.guestflow.in.net/api/v1/properties

List all properties for your account.

GEThttps://www.guestflow.in.net/api/v1/properties/{id}

Get property details including photos.

PATCHhttps://www.guestflow.in.net/api/v1/properties/{id}

Update name, description, isActive, website, whatsapp, email, or phone.

{
  "name": "Villa Serenity",
  "isActive": true,
  "website": "https://example.com"
}

GEThttps://www.guestflow.in.net/api/v1/properties/{id}/knowledge

List knowledge base items.

POSThttps://www.guestflow.in.net/api/v1/properties/{id}/knowledge

Add a knowledge item. Types: PDF, DOCX, TEXT, IMAGE. TEXT requires content.

{
  "title": "House Manual",
  "type": "TEXT",
  "content": "Check-in is after 3pm…"
}

DELETEhttps://www.guestflow.in.net/api/v1/properties/{id}/knowledge/{itemId}

Delete a knowledge item.

GEThttps://www.guestflow.in.net/api/v1/properties/{id}/sessions?limit=50&offset=0

List chat sessions with recent messages. Returns sessions, total, limit, offset.

Outbound webhooks

Register HTTPS endpoints in the dashboard. We POST JSON when subscribed events fire — including from dashboard actions and API mutations.

property.updated
knowledge.created
chat.session.created

{
  "event": "property.updated",
  "timestamp": "2026-07-15T00:00:00.000Z",
  "data": { "propertyId": "…", "slug": "villa-serenity" }
}

Verify signatures

Every delivery includes X-GuestFlow-Signature as t=<unix_seconds>,v1=<hex>. Recompute HMAC-SHA256 over "{t}.{rawBody}" using your signing secret (shown once when you create the endpoint).

X-GuestFlow-Signature: t=1710000000,v1=<hmac_hex>

Errors

Failed responses return JSON with error and optional code. Common status codes: 401 invalid key, 403 Business plan required or rate limited, 404 not found, 429 too many requests. Send X-GuestFlow-Locale to localize error messages.

View Business plan pricing →

← Torna alla home