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

The Facilities API from AlayaCare — 4 operation(s) for facilities.

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

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

This API exposes 7 operations across 4 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.17.

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

7 operations 4 paths 28 schemas 4 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

  • basic_auth — Basic HTTP auth over https

Paths & Operations 7

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

Facilities 7
GET
/facilities
Get a list of facilities
4 params → 200401
GET
/facility_visits
Get a list of facility visits
12 params → 200401
POST
/facility_visits
Create a new facility visit
body → 201400401
GET
/facility_visits/{alayacare_visit_id}
Get facility visit details
1 param → 200401404
PUT
/facility_visits/{alayacare_visit_id}
Update facility visit details
1 param body → 200400401404
GET
/facility_visits/by_id/{visit_id}
Get facility visit details
1 param → 200401404
PUT
/facility_visits/by_id/{visit_id}
Update facility visit details
1 param body → 200400401404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are BaseVisitDetails (24 properties), BaseVisit (13 properties), BaseVisitUpdate (10 properties), Address (10 properties). Each schema is shown below with its type and property counts.

Address
object
10 properties
ErrorResponse
object
Error response
2 properties 2 required
VisitTag
string
Name of tag.
VisitCancelCode
objectnull
Visit cancellation code
3 properties 2 required
FacilityList
object
1 property
BaseVisitDetails
object
24 properties 14 required
FacilityVisit
object
3 properties 1 required
VisitWorkSession
object
Visit work session
5 properties
FacilityProfile
object
Collection of key/value pairs where keys are existing attributes in the agency profile, defined through the AlayaCare web application. On the example below def…
1 property
VisitDailyActivity
object
Activity of daily living
3 properties
Location
objectnull
User location information
2 properties
VisitActivityCode
object
3 properties 2 required
FacilityVisitCreate
object
date for creating a facility visit
2 properties 2 required
FacilityVisitList
object
Paginated list of visits
1 property
Facility
object
AlayaCare facility
4 properties 2 required
EmployeeDetails
objectnull
Visit employee details
6 properties 2 required
VisitSkill
object
2 properties 1 required
FacilityVisitDetails
object
3 properties 2 required
PaginatedList
object
Base model of all paginated lists
4 properties 4 required
ClientDetails
object
Visit client details
5 properties 2 required
BaseVisitUpdate
object
AlayaCare visit entity data for updates
10 properties
FacilityVisitUpdate
VisitFunderDetails
object
Visit funder details
7 properties 2 required
VisitServiceDetails
object
Visit service details
5 properties 4 required
VisitNoteCreate
object
Visit note
1 property 1 required
Branch
object
AlayaCare branch
2 properties
BaseVisit
object
13 properties 6 required
VisitNote
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-facilities-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 Facilities 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.