Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yuzu Health PublicApiV2 API

The PublicApiV2 API from Yuzu Health — 14 operation(s) for publicapiv2.

Yuzu Health PublicApiV2 API is one of 10 APIs that Yuzu Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PublicApiV2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 16 operations across 14 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 0.5.

Requests are made against the base URL https://api.yuzu.health.

16 operations 14 paths 14 schemas 2 DELETE7 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.5
Base URL
https://api.yuzu.health
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Yuzu Health PublicApiV2 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (public-api-auth).

Paths & Operations 16

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

PublicApiV2 16
POST
/v2/groups
Create a group
PublicApiV2Controller_createGroup body → 200
GET
/v2/groups
List all group policies
PublicApiV2Controller_listAllGroups 1 param → 200
GET
/v2/groups/{groupPolicyId}
Retrieve a group policy
PublicApiV2Controller_getGroup 1 param → 200
POST
/v2/groups/{groupPolicyId}/enroll/initial-enrollment
Create an initial enrollment
PublicApiV2Controller_createInitialEnrollment 1 param body → 200
POST
/v2/groups/{groupPolicyId}/enroll/new-subscribers
Add new subscribers to an existing plan
PublicApiV2Controller_createNewSubscribersEnrollment 1 param body → 200
POST
/v2/enroll/{enrollmentRequestId}/status
Get enrollment request status
PublicApiV2Controller_getEnrollmentRequestStatus 1 param → 200
GET
/v2/groups/{groupPolicyId}/members
List group members
PublicApiV2Controller_listGroupMembers 2 params → 200
DELETE
/v2/groups/{groupPolicyId}/plans/remove/{planIdToRemove}
Remove a plan from a group
PublicApiV2Controller_removePlanFromGroup 2 params → 200
POST
/v2/groups/{groupPolicyId}/plans/add
Add a plan to a group
PublicApiV2Controller_addPlanToGroup 1 param body → 200
GET
/v2/plans/{planId}/spd
Retrieve plan SPD
PublicApiV2Controller_getSpd 1 param → 200
GET
/v2/designs
List all plan designs
PublicApiV2Controller_getDesigns 1 param → 200
POST
/v2/coverages/{coverageId}/care-events
Create a care event
PublicApiV2Controller_createCareEvent 1 param body → 200
GET
/v2/coverages/{coverageId}/care-events
List care events
PublicApiV2Controller_listCareEvents 1 param → 200
POST
/v2/coverages/{coverageId}/care-events/{careEventId}/replacement
Replace a care event
PublicApiV2Controller_replaceCareEvent 2 params body → 200
DELETE
/v2/coverages/{coverageId}/care-events/{careEventId}
Delete a care event
PublicApiV2Controller_deleteCareEvent 2 params → 200
GET
/v2/designs/{planDesignId}/benefits
Retrieve plan design benefits
PublicApiV2Controller_getDesignBenefits 1 param → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are GroupCreationDto (17 properties), CareEventCreationDto (10 properties), CareEventDto (10 properties), GroupPolicyDto (7 properties). Each schema is shown below with its type and property counts.

GroupPolicyDto
object
7 properties 6 required
PaginatedGroupPolicyDto
object
2 properties 1 required
Uint8Array
object
CareEventCreationDto
object
10 properties 8 required
EnrollmentRequestDto
object
3 properties 3 required
BenefitsDto
object
4 properties 4 required
CareEventArrayDto
object
1 property 1 required
PlanCreationDto
object
4 properties 1 required
PaginatedMemberDto
object
2 properties 1 required
PlanDesignArrayDto
object
1 property 1 required
InitialEnrollmentDto
object
2 properties 2 required
GroupCreationDto
object
17 properties 6 required
CareEventDto
object
10 properties 10 required
NewSubscribersEnrollmentDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yuzu-health-publicapiv2-api-openapi.yml Raw ↑

Other APIs Yuzu Health publishes across the network.

Yuzu Health Accumulator (Experimental) API
Yuzu Health Benefits API
Yuzu Health Coverage API
Yuzu Health Enrollment API
Yuzu Health EOB (Experimental) API
Yuzu Health Group Policy API
Yuzu Health Member API
Yuzu Health PublicApiV1 API
Yuzu Health Sponsor API