CareMaSym Docs
Connect your system to CareMaSym with organisation-scoped API keys — tenant-isolated, scope-limited, rate-limited and fully audited.
An Organisation Admin issues keys in the CareMaSym app under Settings → Integrations & API. Each key is scoped Read only or Read & write, and the full key (cmk_live_…) is shown exactly once at creation — only a hash is stored, so copy it immediately. The organisation-level "API access" toggle must be enabled for keys to authenticate.
Send the key on each request as "Authorization: Api-Key cmk_live_…" (or an X-Api-Key header). The key sees exactly what its organisation sees — data is tenant-isolated server-side, and read-only keys are rejected on any write. Requests are rate-limited per key (1,000/hour by default). Keys can be revoked instantly from the same settings screen, and every issuance and revocation is written to the audit log.
The REST API lives under /api/v1/ on your CareMaSym API origin. A complete, always-current OpenAPI 3 schema is served at /api/v1/schema/ (machine-readable, ready for client-code generation) and interactive Swagger documentation at /api/v1/docs/. Core resources include service-users, visits, care-notes, incidents, medication-records, risk-assessments, body-map and reports.
curl -H "Authorization: Api-Key cmk_live_…" https://<your-api-origin>/api/v1/service-users/ — returns the organisation’s service users as JSON, paginated 25 per page. List endpoints accept filters such as ?service_user=, ?from= and ?to= for date ranges; see the schema for the full set per resource.
Ask us for a sandbox: we provision an isolated sandbox organisation seeded with a month of realistic care data (staff, service users, care plans, visits with check-ins, medication records, incidents, body-map entries and risk assessments) and issue you a cmk_test_… key. Sandbox keys only ever authenticate against sandbox organisations — they can never touch production data — so your integration can be built and verified end-to-end safely. The API surface is identical to production.