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

The Employees API from AlayaCare — 7 operation(s) for employees.

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

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

This API exposes 10 operations across 7 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version 1.0.8.

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

10 operations 7 paths 23 schemas 5 GET1 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

  • basic_auth — Basic HTTP auth over https

Paths & Operations 10

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

Employees 10
GET
/employees
Get a list of employees.
8 params → 200401
POST
/employees
Create an employee.
body → 201409400401
GET
/employees/{employee_id}
Get employee details using its AlayaCare ID
1 param → 200404
PUT
/employees/{employee_id}
Modify employee details using its AlayaCare ID
1 param body → 200404
GET
/employees/by_id/{external_employee_id}
Get employee using an external ID provided on creation
1 param → 200404
PUT
/employees/by_id/{external_employee_id}
Modify employee details using an external ID provided on creation
1 param body → 200404
PUT
/employees/{employee_id}/status
Update employee status using its AlayaCare ID
1 param body → 200400404
PUT
/employees/by_id/{external_employee_id}/status
Update employee status using an external ID provided on creation
1 param body → 200400404
GET
/employees/{employee_id}/picture
Get employee profile picture pre-authorized URL.
2 params → 200404
GET
/employees/by_id/{external_employee_id}/picture
Get employee profile picture pre-authorized URL.
2 params → 200404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are EmployeeDetails (28 properties), EmployeeUpdate (18 properties), Employee (14 properties), EmployeeContact (8 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error response
2 properties 2 required
ProfilePictureUrl
object
1 property
EmployeeUpdate
object
AlayaCare employee entity data for creation
18 properties
EmployeeStatus
string
Enum of the status of an employee
CostCentre
objectnull
Details of a cost centre
4 properties
EmploymentType
object
Employment Type
2 properties 1 required
BranchSummary
object
Branch summary
2 properties
EmployeeList
object
List of employees
1 property
SuccessResponse
object
Success response.
2 properties 2 required
Location
objectnull
Location information
3 properties
Group
object
AlayaCare group.
2 properties 2 required
Department
object
AlayaCare department.
2 properties 2 required
Employee
object
AlayaCare employee list view
14 properties
EmployeeDemographics
object
Collection of key/value pairs where keys are existing attributes in the employee profile, defined through the AlayaCare webapp. On the example below default pr…
4 properties 3 required
EmployeeDetails
object
AlayaCare employee entity
28 properties 7 required
Skill
object
A skill or qualification associated to an employee
2 properties
PaginatedList
object
Base model of all paginated lists
3 properties 4 required
EmployeeContactDemographics
object
Collection of key/value pairs where keys are existing attributes in the employee contact profile, defined through the AlayaCare web application. On the example…
2 properties
Role
object
AlayaCare role
4 properties 2 required
EmployeeStatusCreate
string
Enum of the status of an employee
EmployeeCreate
object
3 properties 1 required
EmployeeStatusUpdate
object
AlayaCare employee entity data for status update
2 properties 1 required
EmployeeContact
object
8 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-employees-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 Employees 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.