GoodInbound

Getting Started

Choose an integration#

Start with the guide for the capability you want to add. Each guide covers setup, requests, responses, limits, and failure handling.

Guide What you can build
Lead Screening & Spam Protection API Screen existing forms through REST, JavaScript, or inbound webhooks.
Lead Enrichment API Research and enrich saved contacts through REST and MCP.
Click Fraud Protection Monitor paid clicks for fraud and report only verified leads to Google Ads, Meta, and TikTok.
Lead Status Webhooks Report accepted leads and receive signed acceptance and withdrawal events.
Form Backend API Build custom forms with step saving, file uploads, and spam protection.
Scheduling API Check availability, create bookings, and manage confirmation and cancellation.

Installation#

The fastest way to add GoodInbound to your site is with the embeddable widgets. Drop in a script tag and initialize it with your project slug and the event type or form slug.

Booking Widget

<div id="booking-widget"></div>
<script src="https://cdn.goodinbound.com/widgets/booking.js"></script>
<script>
  GoodInbound.booking({
    projectSlug: "your-project",
    eventTypeSlug: "intro-call",
    container: "#booking-widget"
  });
</script>

Form Widget

<div id="form-widget"></div>
<script src="https://cdn.goodinbound.com/widgets/form.js"></script>
<script>
  GoodInbound.form({
    projectSlug: "your-project",
    formSlug: "contact",
    container: "#form-widget"
  });
</script>

See Form Widget and Booking Widget for installation and customization options.

Quick start#

  1. Create a project in the dashboard.
  2. Create an event type or form.
  3. Embed a widget, or call the anonymous visitor endpoints from your own form or booking UI.
  4. For server-side management, create a project API key under MCP & APIs.

Check available slots

curl "https://goodinbound.com/api/v1/availability/your-project?date=2026-10-20&timezone=UTC&eventTypeSlug=consultation"

How it works#

  1. Your client sends a request to the GoodInbound API.
  2. The server validates input and checks availability or the form config.
  3. The action runs: a booking is created, a form step is saved, and so on.
  4. The response returns the result.
  5. Workflows for that event run afterwards (emails, webhooks, tags).

JSON errors include a descriptive error field and may include a stable code. Successful responses vary by operation: JSON resources, file bodies, and empty 204 responses are all used where appropriate.

Credentials and base paths#

API Base path Use it for
Visitor API /api/v1/forms/*, /api/v1/availability/*, /api/v1/bookings Public form and booking flows. No secret key in the browser; private file downloads require a server-side key.
Lead Screen API /api/v1/leadscreen/* Screening and collection with a publishable browser key or secret server key. Result tokens and webhook URLs have their own scoped credentials.
Share-link API /api/public/* Public link resolution and form configuration used by GoodInbound share pages. New direct integrations should use /api/v1/*.
Management API /api/projects/:projectId/* Server-side project administration with a project API key. Never expose the key in a browser, widget, or public form.

Endpoint catalog#

Visitor endpoints support public form submissions, availability, booking creation, widgets, and public link resolution without a secret API key. Private response-file downloads require a server-side key. Lead Screen uses the separate credentials described in its guide. See Form Backend API and Scheduling API.

Management endpoints live under /api/projects/:projectId/*. Send Authorization: Bearer gi_live_... from a server, secure automation, or local agent. The key must belong to the project in the URL, and the project must have API access on its current plan.

Dashboard-only operations#

Project creation and deletion, members, API key management, billing, and OAuth connections are dashboard-only. Account, team, and onboarding operations are session-only too. API keys get api_key_route_forbidden for these; use the dashboard instead.