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

The Visits API from AlayaCare — 8 operation(s) for visits.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 13 operations across 8 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://homecare.alayacare.ca/ext/api/v2/tasks/forms20, https://homecare.alayacare.ca/ext/api/v2/scheduler.

13 operations 8 paths 36 schemas 2 DELETE7 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

AlayaCare Visits API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP basic authentication (basic_auth).

  • basicAuth — Basic HTTP auth over https
  • basic_auth — Basic HTTP auth over https

Paths & Operations 13

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

Visits 13
GET
/submissions/visits
Get a list of visits and submissions given a client id.
10 params → 200401400403
GET
/cancelcodes
Get a list of cancel codes
3 params → 200
GET
/visits
Get list of visits
18 params → 200401
POST
/visits
Create a new visit
body → 201400401
GET
/visits/{alayacare_visit_id}
Get visit details using AlayaCare ID
1 param → 200401404
PUT
/visits/{alayacare_visit_id}
Update visit details using AlayaCare ID
1 param body → 200400401404
DELETE
/visits/{alayacare_visit_id}
Delete visit using AlayaCare ID
1 param → 204401404
GET
/visits/by_id/{visit_id}
Get visit details using external ID
1 param → 200401404
PUT
/visits/by_id/{visit_id}
Update visit details using external ID
1 param body → 200400401404
DELETE
/visits/by_id/{visit_id}
Delete visit using external ID
1 param → 204401404
PUT
/visits/lock
Lock list of visits using Alayacare visit ID or external visit ID
body → 200207400401
GET
/visits/{alayacare_visit_id}/delivery_date
Get the delivery date of a visit given the ID
1 param → 200404
GET
/visits/{client_id}/next_visit_id
Get the next visit ID for a client
3 params → 200404

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are BaseVisitDetails (24 properties), BaseVisit (13 properties), Address (10 properties), BaseVisitUpdate (10 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error response
2 properties 2 required
VisitBySubmission
object
7 properties
VisitBySubmissionList
object
A list of visits
5 properties 5 required
Address
object
10 properties
ErrorResponse_2
object
Error response
2 properties 2 required
VisitTag
string
Name of tag.
VisitCancelCode
objectnull
Visit cancellation code
3 properties 2 required
BaseVisitDetails
object
24 properties 14 required
VisitCancelCodeList
object
Paginated list of cancel codes
1 property
VisitWorkSession
object
Visit work session
5 properties
DeliveryDateInformation
object
2 properties
VisitDailyActivity
object
Activity of daily living
3 properties
Location
objectnull
User location information
2 properties
VisitActivityCode
object
3 properties 2 required
VisitIDList
object
2 properties
VisitList
object
Paginated list of visits
1 property
VisitUpdate
object
2 properties
NextVisitId
object
1 property
VisitDetails
object
6 properties 2 required
Visit
object
2 properties 1 required
EmployeeDetails
objectnull
Visit employee details
6 properties 2 required
VisitFacilityDetails
objectnull
Visit facility
4 properties 2 required
VisitTimekeeping
object
The state of the verified start and end times
4 properties
VisitSkill
object
2 properties 1 required
PaginatedList
object
Base model of all paginated lists
4 properties 4 required
VisitCreate
AlayaCare visit entity data for creation
2 required
BaseVisitUpdate
object
AlayaCare visit entity data for updates
10 properties
VisitUpdatePartialSuccessResponse
object
4 properties
VisitFunderDetails
object
Visit funder details
7 properties 2 required
VisitServiceDetails
object
Visit service details
5 properties 4 required
VisitNoteCreate
object
Visit note
1 property 1 required
ClientBranchDetails
object
Visit client details
6 properties 2 required
VisitListDetails
object
3 properties 1 required
Branch
object
AlayaCare branch
2 properties
BaseVisit
object
13 properties 6 required
VisitNote
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-visits-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
#Visits
← Back to A APIs
API Details
ID
alayacare:alayacare-visits-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-visits-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/alayacare-visits-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 Visits 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.