Hi, how can we help? 👋

API Overview

Introduction to the Timerise API

Last updated: January 8, 2024

API Overview

The Timerise API allows you to integrate booking functionality into your own applications.

Authentication

All API requests require authentication using API keys:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.timerise.io/v1/bookings

Getting Your API Key

  1. Navigate to Settings > API
  2. Click Generate API Key
  3. Store securely - it won't be shown again

Base URL

https://api.timerise.io/v1

Core Endpoints

Bookings

GET    /bookings          # List all bookings
POST   /bookings          # Create a booking
GET    /bookings/:id      # Get booking details
PATCH  /bookings/:id      # Update a booking
DELETE /bookings/:id      # Cancel a booking

Services

GET    /services          # List services
POST   /services          # Create a service
GET    /services/:id      # Get service details

Availability

GET    /availability      # Check available time slots

Example: Creating a Booking

const response = await fetch('https://api.timerise.io/v1/bookings', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    service_id: 'srv_123',
    customer_email: 'customer@example.com',
    customer_name: 'John Doe',
    start_time: '2024-02-15T10:00:00Z',
    duration: 30
  })
});

const booking = await response.json();

Rate Limits

  • Free: 100 requests/hour
  • Professional: 1,000 requests/hour
  • Enterprise: Custom limits

Webhooks

Subscribe to events in real-time:

  • booking.created
  • booking.updated
  • booking.cancelled

Configure webhooks in Settings > Webhooks.

SDKs

Official SDKs available for:

  • JavaScript/TypeScript
  • Python
  • Ruby
  • PHP

Support

Questions? Contact our developer support team or visit our full API documentation at docs.timerise.io