Documentation

Quick Start Guide

Follow these steps to set up your Reservr account in minutes:

1. Create Your Account: Sign up with your business email and create a strong password. We'll send you a verification email to confirm your account.
2. Business Setup: Enter your business information, including name, address, contact details, and business type (salon, spa, wellness center, etc.).
3. Add Services: Create your service offerings with pricing, duration, and descriptions. You can add categories to organize your services.
4. Set Your Schedule: Configure your working hours, break times, and availability for each day of the week.
5. Invite Team Members: Add staff members, assign roles (admin, staff, receptionist), and set their individual schedules.
6. Customize Your Booking Page: Personalize your public booking page with your branding, colors, and logo.
7. Set Up Payments: Connect your preferred payment processor (Stripe, Square, PayPal) to accept online payments.
8. Configure Notifications: Set up email and SMS notifications for appointments, reminders, and cancellations.

Account Setup

Complete your account setup to unlock all features and ensure optimal performance:

Essential Setup Steps

• Email Verification: Verify your email address to secure your account and receive important notifications
• Business Profile: Complete your business profile with accurate information for client-facing features
• Payment Processing: Set up payment processing to accept online payments and deposits
• Notification Preferences: Configure how and when you want to receive notifications
• Business Logo: Upload your business logo for branding consistency across all touchpoints

Advanced Configuration

• Booking Rules: Set up advance booking limits, cancellation policies, and buffer times
• Client Communication: Customize email templates and SMS messages
• Integrations: Connect with calendar apps, email marketing tools, and other business software
• Security Settings: Enable two-factor authentication and configure access controls

Your First Appointment

Create your first appointment to test the system and familiarize yourself with the workflow:

Step-by-Step Process

1. Navigate to Appointments: Go to the Appointments section in your dashboard
2. Create New Appointment: Click "New Appointment" or use the calendar view to select a time slot
3. Select or Add Client: Choose an existing client or create a new client profile
4. Choose Service: Select the service from your configured service list
5. Set Time and Duration: Confirm the appointment time and duration
6. Add Details: Include any notes, special instructions, or client preferences
7. Assign Staff: Select which team member will handle the appointment
8. Save and Confirm: Save the appointment and send confirmation to the client

Testing Different Scenarios

• Create appointments with different services and durations
• Test the client notification system
• Try rescheduling and cancelling appointments
• Test the payment collection process
• Verify that team members receive appropriate notifications

Best Practices

Follow these best practices to get the most out of Reservr:

Data Management

• Keep client information up-to-date and accurate
• Use consistent naming conventions for services and categories
• Regularly review and update your service pricing
• Maintain accurate team member schedules and availability

Client Experience

• Set up automated reminders to reduce no-shows
• Use clear, descriptive service names and descriptions
• Enable online booking for convenience
• Collect client feedback to improve your services

Business Operations

• Review your appointment data regularly for insights
• Use the reporting features to track performance
• Train your team on proper system usage
• Keep backups of important data

Dashboard Overview

Your dashboard is the central hub of your Reservr account. Here's what you'll find:

• Today's Appointments: View and manage today's scheduled appointments
• Revenue Summary: Track your daily, weekly, and monthly revenue
• Client Activity: See recent client interactions and bookings
• Quick Actions: Fast access to common tasks
• Notifications: Important updates and reminders

Managing Appointments

Efficiently manage your appointment schedule:

Creating Appointments

• Use the calendar view to see your schedule
• Click on any time slot to create a new appointment
• Select the client and service
• Add notes or special instructions

Modifying Appointments

• Click on any appointment to edit details
• Reschedule by dragging to a new time slot
• Cancel appointments with automatic client notification
• Add or remove services from existing appointments

Client Management

Keep track of your clients and their information:

• Client Profiles: Store contact information, preferences, and history
• Appointment History: View past and upcoming appointments
• Notes & Preferences: Record important client information
• Communication: Send emails and SMS directly from client profiles

Authentication

All API requests require authentication using your API key. You can find your API key in your account settings under "API Keys".

API Key Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.reservr.com/v1/appointments

Rate Limiting

API requests are limited to 1000 requests per hour per API key. Rate limit information is included in response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

API Endpoints

Complete reference for all available API endpoints:

{
  "data": [
    {
      "id": "apt_123",
      "client_id": "client_456",
      "service_id": "service_789",
      "start_time": "2024-01-15T10:00:00Z",
      "end_time": "2024-01-15T11:00:00Z",
      "status": "confirmed",
      "notes": "Regular haircut appointment"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 50,
    "offset": 0
  }
}

{
  "client_id": "client_456",
  "service_id": "service_789",
  "start_time": "2024-01-15T10:00:00Z",
  "end_time": "2024-01-15T11:00:00Z",
  "notes": "Regular haircut appointment"
}

{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "date_of_birth": "1990-01-01",
  "notes": "Prefers morning appointments"
}

Webhooks

Receive real-time notifications about events in your account. Webhooks are HTTP callbacks that send event data to your specified URL.

Setting Up Webhooks

Configure webhooks in your account settings under "Integrations" → "Webhooks":

POST /v1/webhooks
{
  "url": "https://your-app.com/webhooks/reservr",
  "events": ["appointment.created", "appointment.updated"],
  "secret": "your_webhook_secret"
}

Available Events

Webhook Payload Example

{
  "id": "evt_123",
  "type": "appointment.created",
  "created": "2024-01-15T10:00:00Z",
  "data": {
    "object": {
      "id": "apt_123",
      "client_id": "client_456",
      "service_id": "service_789",
      "start_time": "2024-01-15T10:00:00Z",
      "end_time": "2024-01-15T11:00:00Z",
      "status": "confirmed"
    }
  }
}

Error Handling

Our API uses conventional HTTP response codes to indicate success or failure of requests.

HTTP Status Codes

Error Response Format

{
  "error": {
    "type": "invalid_request_error",
    "message": "The request was invalid",
    "code": "invalid_parameter",
    "param": "email"
  }
}

Common Issues

Appointments Not Syncing

If appointments aren't syncing with your calendar:

1. Check your calendar integration settings
2. Verify your calendar permissions
3. Try disconnecting and reconnecting your calendar
4. Contact support if the issue persists

Payment Processing Issues

If payments aren't processing correctly:

1. Verify your payment processor settings
2. Check your account status with the processor
3. Ensure your bank account is properly linked
4. Review recent transaction logs