Proximity API Documentation

Welcome to the Proximity developer documentation. This guide covers the public API — everything you need to integrate Proximity scheduling into your application, website, or workflow.

What is Proximity?

Proximity is a meeting scheduling platform that lets individuals and teams manage availability, accept bookings, and automate scheduling workflows. Think of it as the scheduling infrastructure your product can build on top of.

What can you build?

With the Proximity public API, you can:

• Display available time slots on your own website or app
• Create bookings programmatically from any frontend or backend
• Embed scheduling widgets directly into your pages (inline, popup, or floating button)
• React to booking events in real time via webhooks (created, cancelled, rescheduled, etc.)
• Build routing flows that qualify leads and direct them to the right event type
• Fetch SEO metadata for booking pages to render rich previews

Base URL

All API endpoints are served from:

https://app.proximity.io/api

Public vs Authenticated API

This documentation covers the public API — endpoints that require no authentication and are designed for external integrators. These include:

The authenticated API (for managing event types, teams, settings, etc.) is used internally by the Proximity dashboard and is not covered here.

Quick Example

Fetch available slots for a user’s event type:

curl "https://app.proximity.io/api/public/scheduling/jane-doe/30min-call/slots?\
dateFrom=2026-03-15&dateTo=2026-03-21&timezone=America/New_York"

Response:

[
  {
    "date": "2026-03-16",
    "slots": [
      {
        "startTime": "2026-03-16T14:00:00Z",
        "endTime": "2026-03-16T14:30:00Z",
        "spotsRemaining": null
      },
      {
        "startTime": "2026-03-16T15:00:00Z",
        "endTime": "2026-03-16T15:30:00Z",
        "spotsRemaining": null
      }
    ]
  }
]

Ready to get started? Head to the Getting Started guide.