API Reference

Overview

The RoostSync API allows developers to integrate with RoostSync programmatically. Build custom integrations, connect third-party services, or automate workflows.

API Preview

Here is a preview of what the RoostSync API will offer:

Planned Endpoints

Resource	Operations
Bookings	List, Create, Read, Update, Cancel
Rooms	List, Read, Update availability
Guests	List, Create, Read, Update
Orders	List, Create, Read
Inventory	List, Read, Update stock
Reports	Generate various reports

Authentication

The API will use API key authentication:

Authorization: Bearer YOUR_API_KEY

API keys will be manageable from Settings > API in your RoostSync account.

Base URL

https://api.roostsync.com/v1/

Example Request (Preview)

GET /v1/bookings
Host: api.roostsync.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Response:
{
  "data": [
    {
      "id": "bk_12345",
      "guest_name": "Juan dela Cruz",
      "room": "Room 101",
      "check_in": "2024-03-15",
      "check_out": "2024-03-17",
      "status": "confirmed",
      "total": 6000
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "per_page": 20
  }
}

Rate Limits

To ensure fair usage, the API will have rate limits:

• Standard: 100 requests per minute
• Burst: Up to 200 requests for short periods
• Rate limit headers will be included in responses

Use Cases

Common integrations the API will enable:

• Connect your own website's booking form
• Sync with accounting software
• Build custom dashboards
• Integrate with channel managers
• Automate guest communication
• Create custom reports

Request API Access

Interested in early access to the API? Contact us:

• Email: api@roostsync.com
• Subject: API Early Access Request
• Include: Your use case and expected volume

Current Integrations

While the full API is in development, you can currently integrate via:

• Gmail Sync - Automatic OTA booking import
• Webhooks - Receive notifications (coming soon)
• Export/Import - CSV data exchange