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 Services API

The Services API from AlayaCare — 3 operation(s) for services.

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

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

This API exposes 6 operations across 3 paths, and defines 21 schemas. It is described by OpenAPI 3.2.0, at version 1.1.0.

Requests are made against 3 base URLs: https://homecare.alayacare.ca/ext/api/v2/scheduler, https://homecare.uat.alayacare.ca/ext/api/v2/scheduler, https://homecare.staging.alayacare.ca/ext/api/v2/scheduler.

6 operations 3 paths 21 schemas 3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

AlayaCare Services API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 6

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

Services 6
GET
/services
Get list of services
11 params → 200400401
POST
/services
Create a service
body → 200400401409
GET
/services/{alayacare_service_id}
Get service details using AlayaCare ID
2 params → 200401404
PUT
/services/{alayacare_service_id}
Update service details using AlayaCare ID
2 params body → 200400401404409
GET
/services/by_id/{service_id}
Get service details using external ID
2 params → 200401404
PUT
/services/by_id/{service_id}
Update service details using external ID
2 params body → 200400401404409

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ServiceProviderDetails (25 properties), ServiceSchema (24 properties), ServiceDetails (19 properties), Service (8 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error response
2 properties 2 required
ServiceStatus
string
Current service status.
CostCentre
object
Details of a cost centre
4 properties
ServiceSchema
object
24 properties
ServiceRelationSchema
object
1 property
ServiceCreateSchema
object
2 properties 5 required
ServiceUpdate
object
AlayaCare service entity data for updating
8 properties
SuccessResponse
object
Success response.
2 properties 2 required
ServiceList
object
Paginated list of services
1 property
GuidFunderBreakdownsSchema
object
5 properties
ServiceProviderDetails
object
Collection of key/value pairs representing service details for the Service Provider. All values are treated as strings. Corresponds to the "Latest Referral Inf…
25 properties
ServiceDetails
object
19 properties 3 required
EmployeeDetails
object
Visit employee details
6 properties 2 required
ServiceFunderBillingContact
object
2 properties
PaginatedList
object
Base model of all paginated lists
4 properties 4 required
ClientDetails
object
Visit client details
5 properties 2 required
ServiceProfile
object
Collection of key/value pairs where keys are existing attributes in the service profile, defined through the AlayaCare web application. On the example below de…
ProgramCreationDataSchema
object
3 properties
ServiceAccountingSchema
object
7 properties
Service
object
8 properties 3 required
ServiceFunderDetails
object
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-services-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 Services 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.