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

The Premiums API from AlayaCare — 2 operation(s) for premiums.

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

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

This API exposes 4 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.0.19-oas3.

Requests are made against a single base URL, https://example.alayacare.com/ext/api/v2/accounting.

4 operations 2 paths 13 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

AlayaCare Premiums API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth). By default, every request must be authenticated.

  • basic_auth — Basic HTTP auth over https

Paths & Operations 4

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

Premiums 4
GET
/premiums
Get a list of premiums
7 params → 200401403
POST
/premiums
Create a new Premium
body → 201401403
GET
/premiums/{premium_id}
Get a specific Premium
1 param → 200401403404
PUT
/premiums/{premium_id}
Update a Premium
1 param body → 200401403404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are BillCodeQuerySchema (8 properties), PremiumExtendedSchema (7 properties), Premium (6 properties), PremiumCreateSchema (4 properties). Each schema is shown below with its type and property counts.

PremiumCreateSchema
object
4 properties 1 required
ErrorResponse
object
Error response
2 properties 2 required
PremiumUpdateSchema
object
3 properties
BillCodeStub
object
Only one of id or guid should be present
2 properties
PremiumExtendedSchema
object
7 properties
BillCode
object
AlayaCare bill code
2 properties 2 required
PayCode
object
AlayaCare pay code
2 properties
Premium
object
A premium configured in AlayaCare Accounting Settings
6 properties 2 required
PayCodeSchema
object
2 properties
BillCodeQuerySchema
object
8 properties 6 required
PaginatedList
object
Base model of all paginated lists
4 properties 4 required
Branch
object
AlayaCare branch
2 properties
PremiumsList
object
Paginated list of premiums
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alayacare-premiums-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 Premiums 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.