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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
AlayaCare

AlayaCare Clients API

Client related endpoints.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 19 operations across 13 paths, and defines 28 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.

19 operations 13 paths 28 schemas 10 GET5 POST4 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 Clients API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth).

  • basic_auth — Basic HTTP auth over https

Paths & Operations 19

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

Clients 19

Client related endpoints.

GET
/clients
List clients
listClients 7 params → 200401
POST
/clients
Create client
createClient body → 201400401409
GET
/clients/{client_id}
Get client details using its AlayaCare Client ID
detailClient 2 params → 200401404
PUT
/clients/{client_id}
Update client details using its AlayaCare Client ID
updateClient 1 param body → 200401404409
GET
/clients/by_id/{external_client_id}
Get client details using External Client ID
detailClientByExt 1 param → 200401404409
PUT
/clients/by_id/{external_client_id}
Update client details using External Client ID
updateClientByExt 1 param body → 200401404409
GET
/clients/{client_id}/contacts
Get list of client contacts using AlayaCare Client ID
listClientContacts 5 params → 200401404
GET
/clients/by_id/{external_client_id}/contacts
Get list of client contacts using AlayaCare Client external ID
listClientContactsByExt 5 params → 200401404409
GET
/clients/{client_id}/blocked_employees
Get list of employees blocked by this client or blocking this client
listClientBlockedEmployees 1 param → 200404
GET
/clients/by_id/{external_client_id}/blocked_employees
Get list of employees blocked by this client or blocking this client using external client id
listClientBlockedEmployeesByExt 1 param → 200404409
GET
/clients/{client_id}/picture
Get client profile picture pre-authorized URL
getClientPicture 1 param → 200404
GET
/clients/by_id/{external_client_id}/picture
Get client profile picture pre-authorized URL using external client id
getClientPictureByExt 1 param → 200404409
GET
/clients/tags
Get all available tags for clients
listClientTags → 200401
POST
/clients/tags
Create a client tag
createClientTag body → 204400401409
POST
/clients/tags/rename
Rename an existing client tag
renameClientTag body → 204400401404409
POST
/clients/{client_id}/tags
Add tags to a Client using its AlayaCare Client ID
addTagsToClient 1 param body → 201400401404
PUT
/clients/{client_id}/tags
Update tags of a Client using its AlayaCare Client ID
updateClientTags 1 param body → 200400401404
POST
/clients/by_id/{external_client_id}/tags
Add tags to a Client using External Client ID
addTagsToClientByExt 1 param body → 201400401404409
PUT
/clients/by_id/{external_client_id}/tags
Update tags of a Client using External Client ID
updateClientTagsByExt 1 param body → 200400401404409

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ClientDetails (14 properties), ClientListItem (10 properties), ClientContactListItem (10 properties), ClientCreate (10 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…
ProfilePictureUrl
object
1 property
ClientDemographicsLocation
object
Collection of key/value pairs where keys are existing attributes in the patient profile, defined through the AlayaCare webapp. On the example below default pro…
4 properties
ClientTag
string
Name of tag.
ClientCreateDemographics
2 required
CostCentre
objectnull
Details of a cost centre
4 properties
ClientUpdate
object
AlayaCare client entity data for update.
5 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
ClientCreate
object
AlayaCare client entity data for creation.
10 properties
Location
objectnull
Location information
3 properties
SuccessResponse
object
Success response.
2 properties 2 required
ClientList
Group
object
Create Patient group.
2 properties 1 required
ClientTagList
ClientContactListItem
object
10 properties 5 required
Client
object
AlayaCare client list view
9 properties 8 required
ClientStatus
stringnull
CareTeamMember
object
3 properties
ClientContactStatus
string
ClientListItem
object
AlayaCare client list item
10 properties
BlockedEmployeeList
PaginatedList
object
Base model of all paginated lists
4 properties 4 required
ClientDetails
object
AlayaCare client entity
14 properties 9 required
ContactList
ClientDemographics
object
Collection of key/value pairs where keys are existing attributes in the patient profile, defined through the AlayaCare webapp. On the example below default pro…
3 properties
BlockedEmployeeListItem
object
Employee blocked by or blocking a client
3 properties
ClientTagCreate
array
An array of Client tags.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-clients-api-openapi.yml Raw ↑

Other APIs AlayaCare publishes across the network.

AlayaCare Employee API
AE Profile APIs.io
AlayaCare Scheduler API
AE Profile APIs.io
AlayaCare Clinical API
AE Profile APIs.io
AlayaCare Tasks API
AE Profile APIs.io
AlayaCare Forms API
AE Profile APIs.io
AlayaCare Accounting API
AE Profile APIs.io
AlayaCare Medication API
AE Profile APIs.io
AlayaMarket Marketplace API
AE Profile APIs.io
AlayaCare Residential (Resi) API
AE Profile APIs.io
AlayaCare Accounts API
AE Profile APIs.io
AlayaCare Activities of Daily Living (ADL) API
AE Profile APIs.io
AlayaCare Activity Codes API
AE Profile APIs.io
#Clients
← Back to A APIs
API Details
ID
alayacare:alayacare-clients-api
Base URL
https://[tenant].[environment].alayacare.[domain]/ext/api/v2/patients/
Docs
https://alayacare.github.io/external-integration-docs/external-api-guide.html
Provider
AlayaCare
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=alayacare-clients-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/alayacare-clients-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of AlayaCare Clients 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.