⌘K

ReferenceReference

Events endpoints

Exact request and response contracts for the events endpoints, generated from the enforced Partner API contract.

Machine-readable OpenAPI description
On this page

Endpoints in this group

GET/v1/eventsRead the event stream for reconciliation

Important

Base path: /api/public/partner/v1. Every response carries request_id; every failure uses the standard error envelope documented under Errors.

GET/v1/events

Read the event stream for reconciliation

Authentication & scope

  • Authentication: Authorization: Bearer <API key>. The key is bound to one laboratory, one API client and one environment.
  • Required scope: events:read. A key without it is refused with 403 forbidden.

Query parameters

  • cursor (optional) — string
  • limit (optional) — integer

Synthetic schema examples are illustrative, not eligible records. Set PROGRAM_ID and ITEM_ID from granted Programs/Catalog, ORDER_ID and RESULT_ID from current responses, and EXTERNAL_SUBJECT_ID to an opaque synthetic reference. Replace body identifiers with authorized records and include patient/provider/question fields only when current requirements request them. Use Sandbox; Production requires separate approval.

cURL

bash
curl -s "$SOLIA_API_BASE/events" \
  -H "Authorization: Bearer $SOLIA_API_KEY"

Responses

  • 200 — Events after the cursor, oldest first.
  • 401 — Missing, invalid, revoked or expired key.
  • 403 — Client, environment or scope denied.
  • 429 — Per-instance client rate limit exceeded; honor Retry-After.
  • 500 — Canonical request failed; reconcile uncertain actions.
  • 503 — Required API configuration is unavailable.
json
{
  "data": [
    {
      "event_id": "00000000-0000-4000-8000-000000000001",
      "type": "order.created",
      "version": 1,
      "occurred_at": "2026-10-19T00:00:00Z",
      "environment": "sandbox",
      "program_id": "00000000-0000-4000-8000-000000000001",
      "data": {}
    }
  ],
  "request_id": "synthetic",
  "next_cursor": "synthetic"
}

Related resources