R2 Connect API

Site map

Every page of this documentation portal.

Get started

Introduction — Connect your accounting software, point of sale or reporting tool to a business running on R2. Read-only REST API with per-resource permissions.
Quickstart — From zero to your first API response in two minutes: get the key from the business owner and make a request.
Authentication & scopes — How each request is authenticated and what each permission the business owner grants you means.

Pagination & filters — How to walk long lists with cursors and how to narrow results by date and status.
Rate limits — How many requests you may make, how to know how many are left and what to do if you exceed them.
Errors — Error shape, what each code means and how to react to each one.

Account — Identifies which business the key belongs to, its currency and which scopes it holds.
Reservations — Lodging stays with dates, guests, charges, taxes, payments and outstanding balance.
Orders — Every commercial transaction of the business, from any vertical: lodging, restaurant, store and experiences.
Payments — Charges with their method, provider and exact timing. The basis of accounting reconciliation.
Customers — The business’s customer and guest directory with their visit and spending history.
Catalog — Everything the business sells: rooms, dishes, products and experiences, with their base price.

Accounting integration — How to move a business’s income, taxes and collections from R2 into an accounting system, with no manual entry.
POS integration — How to sync catalog and consumption between R2 and a point of sale system.
Reporting & BI — How to feed a dashboard or a data warehouse with a business’s operation running on R2.

OpenAPI spec — Download the API contract in OpenAPI 3.1 format to generate clients or import it into your tools.
Changelog — Version history of R2 Connect API and our compatibility policy.