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 Client Status API

Client status related endpoints.

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

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

This API exposes 10 operations across 4 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.18-oas3.

Requests are made against a single base URL, {server}/ext/api/v2/patients.

10 operations 4 paths 11 schemas 2 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

AlayaCare Client Status 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 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Client Status 10

Client status related endpoints.

GET
/clients/{client_id}/status
Get client status details using its AlayaCare Client ID
listClientStatuses 4 params → 200401404
POST
/clients/{client_id}/status
Create a client status using its AlayaCare Client ID
createClientStatus 1 param body → 200400401404409
GET
/clients/{client_id}/status/{status_id}
Get a client status details using its AlayaCare Client and Status ID
detailClientStatus 2 params → 200401404
PUT
/clients/{client_id}/status/{status_id}
Update a client status using its AlayaCare Client and Status ID
updateClientStatus 2 params body → 200400401404
DELETE
/clients/{client_id}/status/{status_id}
Remove a client status using its AlayaCare Client and Status ID
deleteClientStatus 2 params → 204400401404
GET
/clients/by_id/{external_client_id}/status
Get client status details using External Client ID
listClientStatusesByExt 4 params → 200401404409
POST
/clients/by_id/{external_client_id}/status
Create a client status using External Client ID
createClientStatusByExt 1 param body → 200400401404409
GET
/clients/by_id/{external_client_id}/status/{status_id}
Get a client status details using External Client ID and Status ID
detailClientStatusByExt 2 params → 200401404409
PUT
/clients/by_id/{external_client_id}/status/{status_id}
Update a client status using External Client ID and Status ID
updateClientStatusByExt 2 params body → 200400401404409
DELETE
/clients/by_id/{external_client_id}/status/{status_id}
Remove a client status using External Client ID and Status ID
deleteClientStatusByExt 2 params → 204400401404409

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are ClientStatusDetails (9 properties), ClientStatusCreate (6 properties), ClientStatusUpdate (5 properties), PaginatedList (4 properties). Each schema is shown below with its type and property counts.

ClientStatusDetails
object
AlayaCare client status entity
9 properties
ReasonDetails
object
AlayaCare Status Change Details
2 properties 2 required
ErrorResponse
object
Error response
2 properties 2 required
CreatedByDetails
object
User who created the record
3 properties
ClientStatusCreate
object
AlayaCare client status entity to create
6 properties 2 required
UpdatedByDetails
object
User who updated the record
3 properties
ClientServicesStatus
object
Client service statuses update details if this block is not sent, it is defaulted to FALSE, meaning the services statuses are not updated
3 properties
ClientStatusCreated
object
AlayaCare client status entity
1 property
ClientStatusUpdate
object
AlayaCare client status entity to create
5 properties
PaginatedList
object
Base model of all paginated lists
4 properties 4 required
ClientStatusList

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-client-status-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 Client Status 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.