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

Alleva Clients API

The Clients API from Alleva — 38 operation(s) for clients.

Alleva Clients API is one of 37 APIs that Alleva publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://api.helloalleva.com.

50 operations 38 paths 45 schemas 2 DELETE22 GET8 PATCH18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.helloalleva.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

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

  • Bearer — JWT Authorization header using the Bearer scheme. Enter Bearer [space] and then your token in the text input below. Example: Bearer 12345abcdef

Paths & Operations 50

Across 38 paths, the API surfaces 50 operations — 2 DELETE, 22 GET, 8 PATCH, 18 POST. Each is listed below with its method, path, parameters, and response codes.

Clients 50
POST
/clients/{id}/luin
3 params → 200
PATCH
/clients/{id}/luin
3 params body → 200
GET
/clients/{id}/luin
3 params → 200
POST
/v{version}/clients/{id}/luin
4 params → 200
PATCH
/v{version}/clients/{id}/luin
4 params body → 200
GET
/v{version}/clients/{id}/luin
4 params → 200
GET
/clients/{id}/history
3 params → 200
GET
/v{version}/clients/{id}/history
4 params → 200
GET
/clients/duplicates
7 params → 200
GET
/v{version}/clients/duplicates
8 params → 200
GET
/clients/{id}/urgent-alerts
3 params → 200
POST
/clients/{id}/urgent-alerts
3 params body → 200
PATCH
/clients/{id}/urgent-alerts
3 params body → 200
GET
/v{version}/clients/{id}/urgent-alerts
4 params → 200
POST
/v{version}/clients/{id}/urgent-alerts
4 params body → 200
PATCH
/v{version}/clients/{id}/urgent-alerts
4 params body → 200
POST
/clients/{id}/urgent-alerts/read
3 params body → 200
POST
/v{version}/clients/{id}/urgent-alerts/read
4 params body → 200
GET
/clients/{id}/legacy-form
4 params → 200
GET
/v{version}/clients/{id}/legacy-form
5 params → 200
GET
/clients/{id}/documents
3 params → 200
POST
/clients/{id}/documents
3 params body → 200
GET
/v{version}/clients/{id}/documents
4 params → 200
POST
/v{version}/clients/{id}/documents
4 params body → 200
DELETE
/clients/{id}/documents/{docId}
4 params → 200
DELETE
/v{version}/clients/{id}/documents/{docId}
5 params → 200
POST
/clients/{id}/image
3 params body → 200
POST
/v{version}/clients/{id}/image
4 params body → 200
GET
/clients/{id}/contacts
3 params → 200
GET
/v{version}/clients/{id}/contacts
4 params → 200
POST
/clients/{id}/step-down/documents
3 params body → 200
POST
/v{version}/clients/{id}/step-down/documents
4 params body → 200
POST
/clients/{leadId}/pronoun
3 params body → 200
GET
/clients/{leadId}/pronoun
3 params → 200
POST
/v{version}/clients/{leadId}/pronoun
4 params body → 200
GET
/v{version}/clients/{leadId}/pronoun
4 params → 200
GET
/clients/list
2 params → 200
GET
/v{version}/clients/list
3 params → 200
POST
/clients/{id}/assessments/cows
3 params body → 200
POST
/v{version}/clients/{id}/assessments/cows
4 params body → 200
PATCH
/clients/{id}/assessments/cows/{cowsId}
4 params body → 200
PATCH
/v{version}/clients/{id}/assessments/cows/{cowsId}
5 params body → 200
POST
/clients/{id}/assessments/ciwa
3 params body → 200
POST
/v{version}/clients/{id}/assessments/ciwa
4 params body → 200
PATCH
/clients/{id}/assessments/ciwa/{ciwaId}
4 params body → 200
PATCH
/v{version}/clients/{id}/assessments/ciwa/{ciwaId}
5 params body → 200
GET
/clients
7 params → 200
GET
/v{version}/clients
8 params → 200
GET
/clients/{id}
3 params → 200
GET
/v{version}/clients/{id}
4 params → 200

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are Client (34 properties), Roi (21 properties), Cows (19 properties), User (19 properties). Each schema is shown below with its type and property counts.

UserImageUrl
object
3 properties
AssessmentVitals
object
6 properties
RoiRevoke
object
3 properties
UpdateResult
object
5 properties
ClientDocument
object
13 properties
Document
object
17 properties
UserLicenseType
object
7 properties
JToken
array
Ciwa
object
18 properties
ClientImageUrl
object
3 properties
Reviewer
object
1 property
DocumentData
object
4 properties
UserLicense
object
11 properties
Contact
object
14 properties
Phone
object
5 properties
Address
object
7 properties
CreateOperationResult
integer
UserName
object
4 properties
ClientLogoData
object
2 properties
ClientOccupation
object
4 properties
User
object
19 properties
Cows
object
19 properties
Facility
object
14 properties
ResourceLink
object
2 properties
ClientAssessmentsCows
object
4 properties
Roi
object
21 properties
ClientPronoun
object
2 properties
DocumentUrl
object
3 properties
RoiInformationList
object
3 properties
ClientReferralContact
object
5 properties
CreateResult
object
4 properties
State
object
6 properties
ExternalData
object
4 properties
UserUrgentAlertMarkAsRead
object
3 properties
AlertReadBy
object
2 properties
ClientList
object
17 properties
Client
object
34 properties
ClientAssessmentsCiwa
object
4 properties
Pronoun
object
5 properties
ClientName
object
8 properties
ClientHistory
object
5 properties
ClientUrgentAlert
object
7 properties
ClientContact
object
8 properties
Room
object
6 properties
UpdateOperationResult
integer

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

alleva-clients-api-openapi.yml Raw ↑

Other APIs Alleva publishes across the network.

Alleva Advanced Form API
Alleva Advanced Form Data Backup API
Alleva Advanced Form Element API
Alleva Advanced Form Instance API
Alleva Appointments API
Alleva Bed API
Alleva Bed Occupancy API
Alleva Bed Reservation API
Alleva Client Device API
Alleva Data Facet API
Alleva Data Value API
Alleva Discharge Plan API
Where this information came from

This is an independent, third-party profile of Alleva Clients 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.