v1 · Production-ready

API Reference

REST over HTTPS. JSON in, JSON out. All endpoints are authenticated with a scoped bearer token and return server-time timestamps in ISO-8601 (UTC).

Authentication

curl https://api.nucaincare.co.uk/v1/residents \
  -H "Authorization: Bearer $NUCAIN_TOKEN" \
  -H "Accept: application/json"

GET/v1/residents

List residents, paginated & filterable.

Example response

[{ "id": "r1", "name": "Margaret Holloway", "home": "Maple House", "risk_level": "medium" }]

GET/v1/residents/:id

Fetch a single resident with care plan summary.

Example response

{ "id": "r1", "conditions": ["Dementia", "Type 2 Diabetes"], "next_review": "2026-07-02" }

POST/v1/residents

Create a resident. Requires admin or manager role.

Example response

{ "id": "r9", "status": "created" }

PATCH/v1/residents/:id

Partial update — care notes, key worker, risk level.

Example response

{ "id": "r1", "updated": true }

DELETE/v1/residents/:id

Archive a resident (soft-delete with audit entry).

Example response

{ "id": "r1", "archived": true }

Webhooks

Subscribe to incident.created, medication.missed, shift.completed and 14 more events. HMAC-signed.

Security

Row-level security on every table. Scopes per role. Full audit trail and 90-day token rotation.

SDKs

Official clients for TypeScript, Python and a Postman collection. OpenAPI 3.1 spec available.