Changelog
What each API version shipped. Breaking changes go to a new version; deprecations are announced in advance, both here and via the Deprecation header.
v1.0.0 — initial release
Current version
Initial release of the BeaconCR REST API under /api/v1/. Shipped at launch:
organizations/mestudies, studies/{id}studies/{id}/sitesstudies/{id}/forms (and form versions)studies/{id}/visitsstudies/{id}/participants (and participant data points)studies/{id}/queriesstudies/{id}/epro (instruments, invitations, responses)studies/{id}/consentsstudies/{id}/screeningsstudies/{id}/exportsaudit-eventswebhooks (CRUD)
Platform mechanics shipped with v1.0.0:
- OAuth 2.0 client-credentials authentication, per-client scopes, org-scoped tokens.
- Cursor pagination, ETag/If-Match concurrency, idempotency keys on POST.
- RFC 9457 problem+json errors with a request ID on every response.
- Webhooks with HMAC-SHA256 signatures, retry with backoff, and a delivery log.
- Per-client rate limits (600 requests / 10 min) with RateLimit-* headers.
The resource list above is the launch set; endpoint availability is defined by the OpenAPI document linked from the API reference, which is the contract of record. Additive changes may appear within v1 — see versioning.