Overview

Authentication

All /v1 endpoints require your API key as a Bearer token.

Create and manage keys on the API Keys page. Requests without a valid key return 401.

header

Authorization: Bearer YOUR_LIVE_KEY

The key's prefix says what it is for:

PrefixWhat it can do

oph_live_

Real bookings on /v1. Needs billing set up on your organization; until then every search, availability and booking call returns 402 billing_required.

oph_test_

The same /v1 calls, against real venues, with a free allowance of 3 confirmed bookings per organization. After that, calls return 402 free_tier_exhausted. Practice bookings do not use the allowance. Test keys cannot connect sessions.

oph_beta_

The v3 beta only. On /v1 it gets 403 wrong_key_environment.

A key without the scope a route needs gets 403 insufficient_scope with the required_scope. See Errors.