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

Zywave Benefit Items API

The BenefitItems API from Zywave — 7 operation(s) for benefititems.

Zywave Benefit Items API is one of 84 APIs that Zywave publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 60 JSON Schema definitions.

Tagged areas include BenefitItems. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 60 JSON Schemas.

This API exposes 10 operations across 7 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version v2.0.

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

10 operations 7 paths 17 schemas 1 DELETE7 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2.0
Base URL
https://api.zywave.com
Authentication
OpenID Connect, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Zywave Benefit Items API declares 2 security schemes for authenticating requests. It supports OpenID Connect (oidc) discovered at https://auth.zywave.com//.well-known/openid-configuration. It accepts HTTP bearer tokens (JWT) (bearer).

  • bearer — Enter your JWT access token

Paths & Operations 10

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

BenefitItems 10
GET
/bkb/v2.0/plans/{planId}/benefititemvalues
Get the benefit item values for a plan
BenefitItems_GetBenefitItemValuesForPlan 1 param → 200401403404
POST
/bkb/v2.0/plans/{planId}/benefititemvalues
Creates a benefit item value under a given plan
BenefitItems_PostBenefitItemValue 1 param body → 201400401403404
GET
/bkb/v2.0/plans/{planId}/benefititemvalues/{benefitItemValueId}
Gets a benefit item value for a given plan
BenefitItems_GetBenefitItemValue 2 params → 200401403404
PUT
/bkb/v2.0/plans/{planId}/benefititemvalues/{benefitItemValueId}
Updates a benefit item value under a given plan
BenefitItems_PutBenefitItemValue 2 params body → 204400401403404
DELETE
/bkb/v2.0/plans/{planId}/benefititemvalues/{benefitItemValueId}
Deletes a benefit item value under a given plan
BenefitItems_DeleteBenefitItemValue 2 params → 204401403404
GET
/bkb/v2.0/plans/plantypes/{planTypeId}/benefititems
Get the benefit items for a plan type
BenefitItems_GetBenefitItemsByPlanType 1 param → 200401403404
GET
/bkb/v2.0/plans/plantypes/{planTypeId}/plantypebenefititemtiers
Get the plan type benefit item tiers for a plan type
BenefitItems_GetPlanTypeBenefitItemTiersByPlanType 1 param → 200401403404
GET
/bkb/v2.0/benefititems/benefititemvaluetypes
Returns the list of benefit item value types
BenefitItems_GetBenefitItemValueTypes → 200401403404
GET
/policies/v2.0/benefititems/{id}
Gets a benefit item by id
BenefitItems_GetBenefitItem 1 param → 200401403404
GET
/policies/v2.0/benefititems
Search for benefit item
BenefitItems_SearchBenefitItems 4 params → 200400401403

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are BenefitItem (11 properties), BulkBenefitItemValueInfo (9 properties), BenefitItemInfo (7 properties), PagedResultOfBenefitItem (7 properties). Each schema is shown below with its type and property counts.

ProblemDetails
object
6 properties
BenefitItem
object
11 properties
BenefitItemValue
BenefitItemValueType
object
4 properties 3 required
BenefitItemValueInfo2
BenefitItemValueInfo
ValidationProblemDetails
HttpValidationProblemDetails
PlanTypeBenefitItemTier
object
6 properties
BulkBenefitItemValueInfo
object
9 properties 5 required
BenefitItemValueUpdateInfo
object
3 properties
ProblemDetails_2
object
5 properties
BenefitItemInfo
object
7 properties 1 required
PagedResultOfBenefitItem
object
7 properties
BenefitItem_2
BenefitItemValueType_2
string
BenefitItemCreateInfo

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zywave-benefititems-api-openapi.yml Raw ↑

Other APIs Zywave publishes across the network.

Zywave Account API
Zywave Account Contact API
Zywave Account Contact Driver API
Zywave Account Contacts API
Zywave Account External Reference API
Zywave Accounts API
Zywave Activation API
Zywave Activities API
Zywave Agency API
Zywave Agency Data API
Zywave Agency User API
Zywave Assessment API
Where this information came from

This is an independent, third-party profile of Zywave Benefit Items 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.