Developer API
A REST API over the same records that power the app — service users, visits, care plans, medication and alerts. API-key authenticated, tenant-scoped and UK-hosted.
Integrate CareMaSym with your finance, HR or reporting tools — or build something of your own on top of your data.
Read and write service users, visits, care plans, medication and alerts through a predictable REST API — the same records your team sees in the app.
Authenticate with organisation-scoped API keys issued by your admin — read-only or read & write, revocable in one click, rate-limited, and shown exactly once at creation.
Every key is bound to a single organisation. The API can only ever see and change data for the tenant it belongs to — never another provider’s.
The API runs in the same UK data centre as the platform, so integrating never moves your data out of the country.
Illustrative only — the full reference is shared when your API access is approved.
GET /visitsList scheduled and completed visits, filtered by date, carer or service user.
GET /service-usersRetrieve service users with their care plans and current risk assessments.
POST /service-usersCreate a new service user record with consent and contact details.
GET /care-plans/{id}Fetch a single care plan, including goals and review dates.
POST /medication/administrationsRecord a medication administration with the 6 R’s and outcome.
GET /alertsPoll open alerts such as missed visits, late medication and overdue reviews.
Requests are rate-limited per tenant to keep the platform responsive for everyone. Typical integrations sit well within the limits; higher throughput can be arranged on Enterprise. Responses return the standard rate-limit headers so you can back off gracefully.
The API is available on the Professional and Enterprise plans. Enterprise adds higher rate limits, priority support and an SLA.
Tell us what you would like to build and we will set you up with credentials and the full reference.