How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AlayaCare Interventions API

The Interventions API from AlayaCare — 5 operation(s) for interventions.

AlayaCare Interventions API is one of 113 APIs that AlayaCare publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Interventions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.2.

Requests are made against a single base URL, https://homecare.alayacare.ca/ext/api/v2/clinical.

8 operations 5 paths 15 schemas 1 DELETE3 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.2
Base URL
https://[tenant].[environment].alayacare.[domain]/ext/api/v2/patients/
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

AlayaCare Interventions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth).

  • basic_auth — Basic HTTP auth over https

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Interventions 8
GET
/careplans/intervention_types
Get a list of available intervention types.
→ 200401403404
GET
/careplans/{plan_id}/interventions
Get the intervention list of a Careplan
1 param → 200401403404
POST
/careplans/{plan_id}/interventions
Create an intervention in a Careplan using Alayacare care plan ID
1 param body → 201401403404
GET
/careplans/interventions/{intervention_id}
Get a specific intervention by intervention ID
1 param → 200401403404
PUT
/careplans/interventions/{intervention_id}
Edit the given intervention
1 param body → 204401403404
DELETE
/careplans/interventions/{intervention_id}
Delete a care plan intervention using the intervention ID
1 param → 204400401403404
PUT
/careplans/interventions/{intervention_id}/status/archived
Update intervention status to archived
1 param → 204400401403404
PUT
/careplans/interventions/{intervention_id}/status/completed
Update intervention status to completed
1 param body → 204400401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Intervention (28 properties), CreateCarePlanIntervention (17 properties), DeconstructedFrequency (7 properties), User (2 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error response
2 properties 2 required
InterventionTypeList
object
List of intervention types
1 property
InterventionModule
object
Alayacare module attached to care plan intervention. If not set no alayacare module will be linked to the intervention.
2 properties
EntitySummaryList
array
InterventionList
object
List of interventions
1 property
ExternalLink
object
2 properties 2 required
EntitySummary
object
2 properties 2 required
ServiceList
array
ServiceDetails
objectnull
Service details
2 properties
InterventionType
object
Type of the care plan intervention
User
object
User id, first and last names
2 properties
Intervention
object
Careplan intervention
28 properties 17 required
CareplanItemStatus
string
CreateCarePlanIntervention
object
New intervention to create
17 properties 8 required
DeconstructedFrequency
object
Definition of the intervention frequency. - Is only required if recurrencetype is set to custom - availablefrom and availableto allow to define the Time of day…
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-interventions-api-openapi.yml Raw ↑

Other APIs AlayaCare publishes across the network.

AlayaCare Employee API
AlayaCare Scheduler API
AlayaCare Clinical API
AlayaCare Tasks API
AlayaCare Forms API
AlayaCare Accounting API
AlayaCare Medication API
AlayaMarket Marketplace API
AlayaCare Residential (Resi) API
AlayaCare Accounts API
AlayaCare Activities of Daily Living (ADL) API
AlayaCare Activity Codes API
Where this information came from

This is an independent, third-party profile of AlayaCare Interventions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.