AlayaCare

AlayaCare Clients API

Client related endpoints.

GitHub OpenAPI
Business capability
Patient Registration Management BC-2800.20

Operations 19

GET /clients List clients #
POST /clients Create client #
GET /clients/{client_id} Get client details using its AlayaCare Client ID #
PUT /clients/{client_id} Update client details using its AlayaCare Client ID #
GET /clients/by_id/{external_client_id} Get client details using External Client ID #
PUT /clients/by_id/{external_client_id} Update client details using External Client ID #
GET /clients/{client_id}/contacts Get list of client contacts using AlayaCare Client ID #
GET /clients/by_id/{external_client_id}/contacts Get list of client contacts using AlayaCare Client external ID #
GET /clients/{client_id}/blocked_employees Get list of employees blocked by this client or blocking this client #
GET /clients/by_id/{external_client_id}/blocked_employees Get list of employees blocked by this client or blocking this client using… #
GET /clients/{client_id}/picture Get client profile picture pre-authorized URL #
GET /clients/by_id/{external_client_id}/picture Get client profile picture pre-authorized URL using external client id #
GET /clients/tags Get all available tags for clients #
POST /clients/tags Create a client tag #
POST /clients/tags/rename Rename an existing client tag #
POST /clients/{client_id}/tags Add tags to a Client using its AlayaCare Client ID #
PUT /clients/{client_id}/tags Update tags of a Client using its AlayaCare Client ID #
POST /clients/by_id/{external_client_id}/tags Add tags to a Client using External Client ID #
PUT /clients/by_id/{external_client_id}/tags Update tags of a Client using External Client ID #

Documentation

📖
Documentation
https://alayacare.github.io/external-integration-docs/external-api-guide.html

Specifications

⚙
OpenAPI
https://artifacts.apis.io/alayacare/openapi/alayacare-clients-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/alayacare:alayacare-clients-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

alayacare-clients-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Patients Clients API
  version: 1.0.18-oas3
  description: '**AlayaCare IDs:**

    The following terms are used to reference IDs that identify resources in AlayaCare:

    - client_id

    - status_id

    - contact_id


    **External IDs**

    The following terms are used to reference IDs that identify resources systems external to AlayaCare:

    - external_client_id

    - external_contact_id


    External IDs are required to be unique.'
  contact:
    name: AlayaCare
servers:
- url: '{server}/ext/api/v2/patients'
  variables:
    server:
      default: https://demo3.alayacare.ca
tags:


# --- truncated at 32 KB (43 KB total) ---
# Full source: https://artifacts.apis.io/alayacare/openapi/alayacare-clients-api-openapi.yml