OpenIRIS Public API

A REST API for OpenIRIS association members: pull charges into your ERP, keep billing codes and group memberships in sync with your institutional systems, and connect lab software to your facility data.

Members only. The documentation and specification are public so your IT team (or your software vendor) can evaluate the integration, but API keys are issued only to OpenIRIS association member organisations — by your Provider Admin, inside the OpenIRIS admin application. Not a member yet? Contact the association.

What do you want to build?

Post charges to our ERP

Pull consolidated charges into SAP, Oracle Fusion, NetSuite or Workday as journal entries, with a dedup fence and delta sync. The primary integration surface.

Sync our directory & billing codes

Keep cost-center / WBS codes valid automatically and administer group memberships from your institutional systems.

Connect an ELN or lab tool

For software vendors serving OpenIRIS members: read resources and link experiment records to facility usage.

What is live today

Surface	Endpoints	Status
Resources	`GET/POST /v1/resources`, `GET /v1/resources/{id}`, `POST …/{id}/transitions` (archive), `GET …/{id}/current-booking` (door access)	LIVE
Providers, resource types	`GET /v1/providers`, `…/{id}`; `GET /v1/resource-types`, `…/{id}`	LIVE
Bookings	`GET /v1/bookings`, `…/{id}`; `POST /v1/bookings` (usage entries); `PATCH …/{id}` (external_reference, comments)	LIVE
Charges	`GET /v1/charges`, `…/{id}`, `…/{id}/line-items`, `…/{id}/exports` (GET + POST)	LIVE
Cost centers	`GET/POST /v1/cost-centers`, `GET/PATCH /v1/cost-centers/{id}`	LIVE
Price types	`GET /v1/price-types`, `…/{id}` (`expand=items`), `…/{id}/items`	LIVE
Groups	`GET /v1/groups`, `…/{id}`, `…/{id}/members` (GET/POST/DELETE)	LIVE
Requests	`GET /v1/requests`, `…/{id}`, `…/{id}/participants` (read)	LIVE
Users, projects	`GET /v1/users` (`filter[email]`), `…/{id}`; `GET/POST /v1/projects`, `…/{id}`, `…/{id}/members` (GET/POST/DELETE)	LIVE
Reservations in advance, request writes, webhooks, statistics…	See the roadmap	PROPOSED

The API reference is generated from the running service and describes exactly what is implemented. The roadmap shows the full proposed surface and is open for feedback — several shipped capabilities (cost-center sync, group-member administration) came directly from member feedback on it.

In one glance

Base URL: https://api.openiris.io/v1
Auth: Authorization: Bearer oi_live_<id>_<secret> — per-organisation API keys with scopes
Format: JSON, snake_case, ISO-8601 UTC timestamps, ISO 4217 currency codes
Errors: RFC 9457 application/problem+json with a machine code and trace_id
Rate limit: 600 requests/minute per key by default (headers tell you where you stand)