All API responses are in JSON format unless otherwise specified.
Base URLs
There are two base URLs in use depending on the type of request:
Purpose Base URL
Reports, Charts & Import https://care.personcentredsoftware.com/mcm/
Legacy Endpoints https://monitor.personcentredsoftware.com/MCM/
Authentication
Method 1: Basic Authentication (Recommended)
The preferred authentication method uses your mCare login credentials passed as HTTP Basic Auth. This replaces the previous API key method, which remains valid but is no longer the recommended approach.
When making requests via Excel Power Query or similar tools, select Basic authentication and supply your mCare username and password when prompted.
ℹ Info: All data returned is scoped to the access level of the authenticated user. Ensure the account used has the appropriate permissions for the data you wish to extract.
Method 2: API Key
An API key can be generated from your user profile in mCare:
1. Hover over your profile picture in the top-right of the main screen.
2. Click your name — this opens your user details.
3. Navigate to the API Key section.
4. Click Generate new key.
The key persists until regenerated. Append it as a query parameter using:
ℹ Info: Regenerating a key invalidates all existing integrations using the previous key immediately.
Report & Chart Data API
Any report, chart, process or analysis item in mCare that displays a yellow filter bar has a corresponding API endpoint. The endpoint URL is generated dynamically based on the filters applied.
Generating the Endpoint URL
1. Log into mCare and open the desired report, chart or analysis.
2. Apply your filter criteria in the yellow filter bar and click Refresh.
3. Click the API button. The prepared URL is copied to the clipboard automatically.
The generated URL follows this pattern:
https://care.personcentredsoftware.com/mcm/api/v1/BasicAuth/ReportsAndChartsApi/Get/<ReportName>?CommunityID=<guid>&DateFrom=<date>&DateTo=<date>&<additional-filters>
ℹ Info: The parameters embedded in the generated URL reflect exactly the filter state when you clicked Refresh. To change the date range or filters, adjust in the UI and regenerate.
Organisational Data APIs
Organisational APIs provide structured data exports that do not correspond to a specific report. These are designed for use with Excel, Power BI, or other data visualisation tools.
⚠ Note: These endpoints replace the legacy ServiceUsersXML and CarePlansXML endpoints. Migrate any existing integrations to the endpoints below.
Current Service Users — Details & Contacts
Parameters | Parameter Type | Default Value | Required |
includecontacts | boolean | false | No |
communityid | guid | All accessible communities | No |
Current Service Users — Care Plans
Parameters | Parameter Type | Default Value | Required |
communityid | guid | All accessible communities | No |
Data Import API
The import API allows creation of service user and staff records in mCare via POST requests. This cannot be triggered via a browser — use a tool such as Postman or integrate via your own application.
Endpoint
POST
https://care.personcentredsoftware.com/MCM/api/v1//import/person?ValidateOnly=false
Parameters | Parameter Type | Description |
API_KEY | string | Your API key — insert into the URL path |
ValidateOnly | boolean | true = validate without creating. false = create the record |
Request Body — Service User
Send a JSON body in the following format:
{ "ConnectionID": "00000000-0000-0000-0000-000000000000",
"SourceID": null,
"Community": "<community-guid>",
"Staff": false,
"Title": "Mr",
"FirstName": "Jacques",
"LastName": "Noir",
"PreferredName": null,
"Gender": "M",
"DateOfBirth": "01/01/1950",
"Admission": "12/05/2020",
"Email": null,
"NHSNumber": "11187686",
"NINumber": null,
"Room": "4b",
"Risks": "High risk of falls",
"Status": ""
}
Request Body — Staff Member
For staff, set Staff to true and include Role, Job and Email:
{
"ConnectionID": "00000000-0000-0000-0000-000000000000",
"SourceID": null,
"Community": "<community-guid>",
"Staff": true,
"Title": "Mr",
"FirstName": "Jack",
"LastName": "Black",
"Gender": "M",
"DateOfBirth": "01/01/1950",
"Admission": "12/05/2020",
"Email": "[email protected]",
"NHSNumber": "11235686",
"Role": "Carer",
"Job": "Senior carer",
"Status": ""
}
Error Responses
// Validation errors
{
"Errors": {
"Role": "If the person is a staff member, please specify Role",
"Email": "Valid email address is required"
}
}
// Duplicate record errors
{
"Errors": {
"Person": "Person already exists",
"Email": "Email address already exists for another person"
}
}
Legacy API Endpoints
⚠ Note: The endpoints in this section are deprecated and may be removed in a future release. Where a replacement is available it is noted. Migrate new integrations to the Organisational Data APIs above.
Legacy endpoints use the following base URL and syntax: https://monitor.personcentredsoftware.com/MCM/[query]?[param1]&[param2] ... Example: https://monitor.personcentredsoftware.com/MCM/WebApi/ServiceUsersXML?Key=016a7d45-13d781-054b03-209354-158ca968eb0ef7
Complete Endpoint Reference
Data | Endpoint | Parameters |
Current service users | ServiceUsersXML ServiceUsersJson | Key |
Current staff | WorkersXML WorkersJson | Key |
Current care plans | CarePlansXML CarePlansJson | Key, CommunityID (optional) |
Risk assessments (full) | RiskAssessmentsXML RiskAssessmentsJson | Key, CommunityID (optional) |
Risk assessments (12 months) | RiskAssessments12MonthsXML RiskAssessments12MonthsJSON | Key |
Care notes (max 7 days) | CareNotesXML CareNotesJson | Key, StartDate (optional), NumberOfDays |
Fluid notes | FluidCareNotesXML FluidCareNotesJson | Key, CommunityID, StartDate (optional), NumberOfDays |
Weekly turning chart | TurningChartXML TurningChartJson | Key, CommunityID, StartDate |
Staff worked time | WorkedTimeXML WorkedTimeJson | Key, CommunityID, StartDate (optional), NumberOfDays |
Care interactions (summary) | CareInteractionsXML CareInteractionsJson | Key, CommunityID, StartDate (optional), NumberOfDays. Optional: MinimumMinutes, RoundToMinute, Tolerance |
Care interactions (detail) | CareInteractionsDetailXML CareInteractionsDetailJson | Key, CommunityID, StartDate (optional), NumberOfDays. Optional: MinimumMinutes, RoundToMinute, Tolerance |
Care alerts | CareAlertsXML CareAlertsJson | Key, StartDate (optional), NumberOfDays (max 7) |
Group reporting (org wide KPIs) | Groupreportingjson | Key, reportingTimespan (6=weekly/52wks, 52=monthly/12mths) |
Staff on duty | POST: WebApi/WorkersWorkingForCommunity | id:<communityid>, Key:<api-key> |
Get image | GET: Images/RenderImageByID_AuthByKey | id:<imageid>, Key:<api-key> |
Communities/locations | Community | Returns all communities accessible to the user |
Optional Parameter Definitions — Care Interactions
Parameter | Type | Description |
MinimumMinutes | integer | Any care interaction shorter than this value is rounded up to this minimum. |
RoundToMinute | integer | Interactions are rounded up to the next multiple of this value (applied after MinimumMinutes). |
Tolerance | integer | Two interactions with a gap smaller than this value (in minutes) are merged into one. |
IgnoreLessThan | integer | Any interaction of less than or equal to this value is rounded down to zero and excluded. |
Need More Help?
If you are still having difficulty, please contact your system administrator or reach out to the Person Centred Software support team. Should you require any data or reporting beyond what is included here, please contact your Customer Success Manager in the first instance to discuss your requirements.