Getting Started

Install the widgets, send your first request, and see how the APIs fit together.

Getting Started
Embed a booking or form widget, make your first API call, and see which API to use for what.
Authentication, Limits, and Errors
API keys, rate limits, error responses, and how each list endpoint paginates.
How It Works
Every interaction with GoodInbound follows a straightforward request/response flow:
API Families
Visitor API (/api/v1/): Canonical anonymous endpoints for availability, bookings, and page form submissions. These routes are safe for visitor-side code and are rate limited by IP.
Endpoint Catalog
Anonymous visitor endpoints cover form responses, file uploads, availability, booking creation, widgets, and public link resolution. They are rate limited and need no credential. Never put an API key in visitor-side code.
Dashboard-only Operations
Project creation and deletion, members, API-key management, billing, and OAuth connections are dashboard-only. Account, team, and onboarding operations are also session-only. API keys receive apikeyrouteforbidden for these operations; use the dashboard instead.