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

The offer inbox API from AlayaCare — 4 operation(s) for offer inbox.

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

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

4 operations 4 paths 35 schemas 2 GET2 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 offer 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 4

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

offer inbox 4
GET
/v1/inbox/offers
Authorization Required role: orgadmin Description Get a collection of Offers matched to the Supply Organization.
6 params → 200
GET
/v1/inbox/offers/{offer_id}
Authorization Required role: orgadmin Description Get the anonamyzed details of Offers matched to the Supply organization. This must contain no PHI.
1 param → 200
POST
/v1/inbox/offers/{offer_id}/accept
Authorization Required role: orgadmin Required offer state: sent Description Accept an Offer matched to the Supply organization.
1 param body → 204
POST
/v1/inbox/offers/{offer_id}/decline
Authorization Required role: orgadmin Required offer state: sent Description Decline an Offer matched to the Supply organization.
1 param body → 204

Schemas 35

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

InboxOfferVisitTaskResponse
object
4 properties 3 required
CareTypeCore
string
PriceCore
object
2 properties 2 required
CarePlanInterventionCore
object
15 properties 8 required
PageNumberCore
integer
InboxOfferVisitResponse
object
5 properties 3 required
OfferReasonCodeCore
object
reasoncode and reasoncomment associated to a cancelled or closed offer.
2 properties
CaseManagerCore
object
4 properties
InboxOfferFormTemplateResponse
InboxOfferAcceptRequest
object
1 property
OfferTypeCore
string
AuthorizationCore
object
24 properties 4 required
PageCore
object
Root page schema for returning collections.
4 properties 4 required
AllergyCore
object
5 properties
InboxOfferDeclineRequest
ServiceCore
object
8 properties 1 required
SortOrderCore
string
OfferMatchStatusCore
stringnull
InboxOfferDetailResponse
object
API response for the anonymous representation of an offer on the inbox API. Similarly to the InboxOfferCore, this schema is meant to be used in the nested offe…
9 properties 5 required
CustomFieldCore
object
3 properties 2 required
InboxOfferPageResponse
OfferMatchResponseCore
string
ItemsPerPageCore
integer
InboxOfferCarePlanResponse
object
6 properties 2 required
InboxOfferAlayaCareResponse
object
3 properties
OfferMatchReasonCodeCore
object
reasoncode associated with a declined Offer Match.
2 properties
InboxOfferCollectionResponse
object
API response for the core representation of an offer response on the inbox API.
2 properties
InboxOfferCore
Core representation of an offer on the inbox API. Meant to be used in the nested offer in a top level (API) response schema.
FormTemplateCore
object
17 properties 15 required
RiskCore
object
4 properties
AddressAnonCore
object
7 properties 4 required
FormTemplateFieldCore
object
10 properties 6 required
OrganizationLeanCore
object
2 properties 2 required
OfferMatchCore
Core representation of an Offer Match. Meant to be used in the nested match in a top level (API) response schema.
SortByCore
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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