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

The referral inbox API from AlayaCare — 5 operation(s) for referral inbox.

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

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

5 operations 5 paths 38 schemas 2 GET3 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 referral 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 5

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

referral inbox 5
GET
/v1/inbox/referrals
Authorization Required role: orgadmin Description Get a collection of Referrals matched to the Supply Organization.
9 params → 200
GET
/v1/inbox/referrals/{referral_id}
Authorization Required role: orgadmin Description Get the anonymized details of Referrals matched to the Supply organization. This must contain no PHI.
1 param → 200
POST
/v1/inbox/referrals/{referral_id}/mark_processed
Authorization Required role: orgadmin Required referral state: assigned Description Acknowledges that the Supply organization has received and processed the assigned Referral. This will mark the Refe…
1 param → 204
POST
/v1/inbox/referrals/{referral_id}/cancel
Authorization Required role: orgadmin Description Cancel an Referral after it's assigned to the Supply Organization. A Referral can only be Cancelled if the status is assigned or processed.
1 param body → 204
POST
/v1/inbox/referrals/{referral_id}/tasks/update
Authorization Required role: orgadmin Description Update referral tasks for a given referral.
1 param body → 204

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are AuthorizationCore (24 properties), FormTemplateCore (17 properties), CarePlanInterventionCore (15 properties), CarePlanGoalCore (12 properties). Each schema is shown below with its type and property counts.

ReferralReasonCodeCore
object
reasoncode associated to a cancelled or closed referral.
1 property
InboxReferralCarePlanInterventionResponse
CareTypeCore
string
InboxReferralDetailResponse
object
API response for the complete representation of an assigned referral on the inbox API. This schema is similar to the InboxAnonReferral except that it includes…
9 properties 5 required
InboxReferralCarePlanResponse
object
8 properties 2 required
PriceCore
object
2 properties 2 required
CarePlanInterventionCore
object
15 properties 8 required
PageNumberCore
integer
CaseManagerCore
object
4 properties
InboxFormTemplateFieldResponse
InboxReferralAlayaCareResponse
object
3 properties
InboxReferralCollectionResponse
object
API response for the core representation of a referral response on the inbox API.
2 properties 2 required
AuthorizationCore
object
24 properties 4 required
CarePlanGoalCore
object
12 properties 5 required
PageCore
object
Root page schema for returning collections.
4 properties 4 required
CustomFieldCore
object
3 properties 2 required
AllergyCore
object
5 properties
SortOrderCore
string
InboxReferralVisitTaskResponse
object
4 properties 3 required
InboxClientTasksUpdateRequest
object
1 property 1 required
ClientCore
object
8 properties 2 required
InboxReferralPageResponse
ReferralStatusCore
string
ItemsPerPageCore
integer
InboxFormTemplateDetailResponse
InboxClientResponse
InboxReferralVisitResponse
object
5 properties 3 required
CarePlanDiagnosisCore
object
9 properties 3 required
FormTemplateCore
object
17 properties 15 required
RiskCore
object
4 properties
InboxCarePlanGoalResponse
ReferralRevisionResponse
object
5 properties 3 required
ReferralTypeCore
string
FormTemplateFieldCore
object
10 properties 6 required
OrganizationLeanCore
object
2 properties 2 required
InboxReferralCancelRequest
AddressCore
object
9 properties 5 required
SortByCore
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-referral-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 referral 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.