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

Client contact related endpoints.

AlayaCare Client Contacts 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 Contacts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 12 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.

5 operations 3 paths 12 schemas 2 GET1 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 Contacts API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth).

  • basic_auth — Basic HTTP auth over https

Paths & Operations 5

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

Client Contacts 5

Client contact related endpoints.

POST
/contacts
Create client contact
createContact body → 201400401404409
GET
/contacts/{contact_id}
Get client contact details using its AlayaCare Client ID
detailContact 3 params → 200400401404
PUT
/contacts/{contact_id}
Update client contact details using its AlayaCare Client ID
updateContact 1 param body → 200400401404409
GET
/contacts/by_id/{external_contact_id}
Get client contact details using External Client ID
detailContactByExt 3 params → 200400401404409
PUT
/contacts/by_id/{external_contact_id}
Update client contact details using External Client ID
updateContactByExt 1 param body → 200400401404409

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ClientContact (15 properties), ClientContactUpdate (14 properties), ClientContactDetails (9 properties), ClientContactRelationship (6 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error response
2 properties 2 required
ClientLanguage
stringnull
Supported language codes. In some cases, a language (e.g. 'english') can be provided when creating an entity, and will be automatically converted to a language…
ClientContactRolesUpdate
object
4 properties
ClientContactDemographics
object
Collection of key/value pairs where keys are existing attributes in the patient contact profile, defined through the AlayaCare web application. On the example…
3 properties
ClientContactUpdate
object
14 properties
ClientContactRelationship
object
AlayaCare client contact relationship specific properties details
6 properties
ClientContactCreate
object
Only one of 'clientid' and 'externalclientid' can be provided
1 property
ClientStatus
stringnull
ClientContactStatus
string
ClientContactDetails
object
AlayaCare client list item
9 properties
ClientContact
object
15 properties 5 required
SuccessResponse
object
Success response.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-client-contacts-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 Contacts 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.