Offisy OAuth API BETA
API under construction
The OAuth API is currently under active development. Breaking changes may occur with short notice. We recommend against using the API in production yet — check the Release Notes regularly.
The Offisy API provides programmatic access to company data via OAuth 2.0.
Authentication
The API uses the OAuth 2.0 Client Credentials grant. You need a client ID and a client secret, which you can create in the Offisy settings. → Set up API access
Request a token
Endpoint: POST https://my.offisy.at/api/oauth/v2/token
Parameters:
| Parameter | Value |
|---|---|
grant_type | client_credentials |
client_id | Your client ID |
client_secret | Your client secret |
Use the token
Send the token as a Bearer token in the Authorization header:
Authorization: Bearer {access_token}The token is only accepted in the header. Requests that send the token as a query parameter or body field are rejected.
Base URL
All API endpoints use the base URL:
https://my.offisy.at/api/oauth/v2/resourceSections
| Section | Description |
|---|---|
| Booking | Users, locations, services, slots, appointment booking |
| Locations | Retrieve locations |
| Users | Retrieve users |
| Services | Retrieve services |
| Service Assignments | Retrieve service assignments |
| Appointments | Retrieve and manage appointments |
| Customers | Retrieve, create, and update customers |
| Notes | Retrieve and create notes |
| Medical fee services | Retrieve, create, and update medical fee services |
| Diagnoses | Retrieve and create diagnoses |
| Files | Retrieve, download, and upload files |
| Anamneses | Retrieve and create anamneses |
| Measurements | Retrieve and create measurements |
| Long-term medications | Retrieve and create long-term medications |
| Sports Exemptions | Retrieve and create sports exemptions |
| Referrals | Retrieve and create referrals |
| Regulations | Retrieve and create regulations |
| Visit Confirmations | Retrieve and create visit confirmations |
| Incoming Referrals | Retrieve and create incoming referrals |
| Doctor Letters | Retrieve and create doctor letters |
| Patient Letters | Retrieve and create patient letters |
| Medical Transports | Retrieve and create medical transports |
| Lab Results | Retrieve and create lab results |
| Illness Notifications | Retrieve and create illness notifications |
| Health Notifications | Retrieve and create health notifications |
| Invoices | Retrieve invoices |
| Cash Revenues | Retrieve cash revenues |
| Fee Notes | Retrieve fee notes |
| Tenants | Retrieve tenants |
| Company | Retrieve company profile |
Further information
- Scopes — Which permissions are available?
- Rate Limits — License tiers, limits, and headers
- Error Handling — Error codes and HTTP status
- Incremental Sync — Timestamp filters, cursor strategy, and residual risks