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 visit inbox API

The visit inbox API from AlayaCare — 14 operation(s) for visit inbox.

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

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

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

Requests are made against a single base URL, https://api.{env}.alayamarket.{region}/offers.

14 operations 14 paths 20 schemas 3 GET11 POST

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
API Key
Resource Areas
1

Authentication & Security 1

AlayaCare visit inbox API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (CognitoAuthorizer). By default, every request must be authenticated.

Paths & Operations 14

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

visit inbox 14
GET
/v1/inbox/visits
Authorization Required role: supply orgadmin who was assigned the associated referral or service. Description Get a collection of Visits for a given referral or service. One of referralid or servicei…
6 params → 200
GET
/v1/inbox/visits/{visit_id}
Authorization Required role: supply orgadmin who created or was assigned the visit. Description Get the details of a Visit for a given Visit ID.
1 param → 200
GET
/v1/inbox/visits/by_inbox_id/{visit_inbox_id}
Authorization Required role: supply orgadmin who created or was assigned the visit. Description Get the details of a Visit for a given inbox Visit ID.
1 param → 200
POST
/v1/inbox/visits/schedule
Authorization Required role: supply orgadmin. Description Schedule a visit by the Supply organization for an associated service or referral. One of referralid or serviceid must be provided.
body → 201
POST
/v1/inbox/visits/{visit_id}/assign
Authorization Required role: supply orgadmin. Description Assign an employee to a visit.
1 param body → 204
POST
/v1/inbox/visits/{visit_id}/unassign
Authorization Required role: supply orgadmin. Description Unassign an employee from a visit.
1 param → 204
POST
/v1/inbox/visits/{visit_id}/delete
Authorization Required role: supply orgadmin. Description Delete a visit of a service referral. The supply organization deleting the visit must be identical to the one that scheduled the original vis…
1 param → 204
POST
/v1/inbox/visits/{visit_id}/hold
Authorization Required role: supply orgadmin. Description Hold a visit of a service referral. The supply organization holding the visit must be identical to the one that scheduled the original visit.
1 param → 204
POST
/v1/inbox/visits/{visit_id}/cancel
Authorization Required role: supply orgadmin. Description Cancel a visit of a service referral. The supply organization cancelling the visit must be identical to the one that scheduled the original v…
1 param → 204
POST
/v1/inbox/visits/{visit_id}/reactivate
Authorization Required role: supply orgadmin. Description Reactivates a visit of a service referral. The supply organization ractivating the visit must be identical to the one that scheduled the orig…
1 param → 204
POST
/v1/inbox/visits/{visit_id}/adjust_timekeeping
Authorization Required role: supply orgadmin. Description Adjust the timekeeping metadata of a visit. The supply organization holding the visit must be identical to the one that scheduled the origina…
1 param body → 204
POST
/v1/inbox/visits/{visit_id}/reschedule
Authorization Required role: supply orgadmin. Description Reschedule a visit of a service referral. The supply organization rescheduling the visit must be identical to the one that scheduled the orig…
1 param body → 200
POST
/v1/inbox/visits/{visit_id}/tasks
Authorization Required role: supply orgadmin. Description Create visit tasks for a visit scheduled by supply from a service referral. Each inbox task id must correspond to a referral task's inboxid.…
1 param body → 200
POST
/v1/inbox/visits/{visit_id}/tasks/complete
Authorization Required role: supply orgadmin. Description Complete one (or more) visit task for the specified visit. Subsequent posts for the same task id updates the task.
1 param body → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are InboxVisitAssignRequest (6 properties), InboxVisitScheduleResponse (6 properties), VisitCore (6 properties), InboxVisitScheduleRequest (5 properties). Each schema is shown below with its type and property counts.

InboxVisitTaskCollectionResponse
object
1 property 1 required
PageNumberCore
integer
InboxVisitCore
InboxVisitTasksCreationRequest
object
1 property 1 required
InboxVisitAdjustTimekeepingRequest
object
2 properties
InboxVisitRescheduleRequest
object
2 properties 2 required
InboxVisitScheduleRequest
object
5 properties 3 required
InboxVisitAssignRequest
object
6 properties 3 required
InboxVisitScheduleResponse
object
6 properties 6 required
PageCore
object
Root page schema for returning collections.
4 properties 4 required
SortOrderCore
string
InboxVisitRescheduleResponse
object
3 properties 3 required
InboxVisitDetailResponse
object
3 properties 2 required
ItemsPerPageCore
integer
InboxVisitTasksCreationResponse
object
1 property
VisitCore
object
6 properties 6 required
InboxVisitTaskCompletionRequest
object
1 property 1 required
InboxVisitCollectionResponse
InboxVisitTaskCompletionCore
object
4 properties 2 required
InboxVisitPageResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-visit-inbox-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 visit inbox 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.