API Reference
This is the complete reference of every endpoint exposed by the Pre-Attendance API. Each operation has its own page with request/response schemas, multi-language examples, and an interactive playground you can run against sandbox.
The pages below are auto-generated from the OpenAPI spec. If you spot a discrepancy with the live API, email support@osigu.com.
Resource groups
| Tag | What's there |
|---|---|
| Pre-Appointment Check-In | HIS integration: POST /his-inbound (create or merge charges, idempotent), PUT /his-inbound/{external_appointment_id} (update header + reconcile charges), DELETE /his-inbound/{external_appointment_id} (soft-delete). |
| Pre-Appointments | Manual CRUD: create, update, get, list (paginated + filters), filter-options, confirm, delete. |
| Pre-Appointment Documents | Upload, list, delete and clear support documents for a pre-appointment. |
| Support Config Upload | Asynchronous CSV upload of required-document configuration per product code, plus process status and errors download. |
Base URLs
| Environment | Base URL |
|---|---|
| Sandbox | https://sandbox.osigu.com/pre-attendance-api |
| Production | https://api.osigu.com/pre-attendance-api |
Endpoint paths in this reference are listed without the base — /v1/checkin/appointments means https://sandbox.osigu.com/pre-attendance-api/v1/checkin/appointments in sandbox.
Authentication
Every endpoint requires a bearer token obtained via the OAuth2 client-credentials grant — the same credentials as the RCM billing API. See Obtaining tokens.
curl -X POST https://sandbox.osigu.com/v1/oauth/token \
-u "$CLIENT_ID:$CLIENT_SECRET" \
-d "grant_type=client_credentials"
# then on every call:
curl https://sandbox.osigu.com/pre-attendance-api/v1/... \
-H "Authorization: Bearer $ACCESS_TOKEN"
Beyond a valid token, each operation requires that your credentials be enabled for that operation. OSIGU provisions this during onboarding, per integration: HIS integration credentials get the /his-inbound operations, reception-desk credentials get the manual pre-appointment and document operations. If a call returns 403 Forbidden, the credential isn't enabled for it — ask your OSIGU contact or email support@osigu.com to have the permission added.
Common HTTP statuses
| Status | Meaning |
|---|---|
200 OK | Success with body (also: HIS inbound no-op). |
201 Created | Resource created (or HIS charge merged). |
202 Accepted | Async work started (support-config upload). |
204 No Content | Success, no body (delete, clear). |
400 Bad Request | Malformed request (e.g. bad CSV MIME/headers). |
401 Unauthorized | Token missing, invalid or expired. |
403 Forbidden | Not allowed (e.g. deleting a HIS document). |
404 Not Found | Not found, or scoped out by your provider. |
409 Conflict | State conflict (e.g. confirming a non-PENDING appointment). |
413 Payload Too Large | File over the limit (25 MB, documents and CSV alike). |
422 Validation error | Body parsed but failed business validation. |
502 Bad Gateway | Upstream (RCM API / storage) unavailable. |
OpenAPI spec download
The raw spec backing this reference is at /pre-attendance-openapi.json.