Skip to Content
Scheduling APIOverview

Scheduling API

The Scheduling API lets you fetch a user’s public profile, query available time slots, and create bookings — all without authentication.

Base Path

/api/public/scheduling

Endpoints

MethodPathDescription
GET/{userSlug}Get user profile and event types
GET/{userSlug}/{eventSlug}/slotsGet available time slots
POST/{userSlug}/{eventSlug}/bookCreate a booking
GET/{userSlug}/{eventSlug}/abuse-configGet abuse prevention settings

Concepts

User Slug

Every Proximity user has a unique slug that identifies their public scheduling page. For example, if the slug is jane-doe, their booking page is at app.proximity.io/schedule/jane-doe.

Event Slug

Each event type also has a slug (e.g., 30min-call, demo, consultation). Combined with the user slug, this uniquely identifies a bookable event.

Timezones

All times in the API use ISO 8601 format in UTC (e.g., 2026-03-16T14:00:00Z). When querying slots, you pass the guest’s IANA timezone (e.g., America/New_York) and the API returns slots appropriate for that timezone.

Booking Status

When a booking is created, it can have one of these statuses:

StatusDescription
ConfirmedBooking is confirmed (default for most event types)
PendingApprovalHost must approve the booking before it’s confirmed
Last updated on