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

The Plans API from Zywave — 14 operation(s) for plans.

Zywave Plans 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 Plans. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 60 JSON Schemas.

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

14 operations 14 paths 64 schemas 12 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 Plans 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 14

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

Plans 14
GET
/bkb/v2.0/plans/{planId}
Gets the account plan (planhistory) by id
Plans_GetPlanById 1 param → 200401403404
PUT
/bkb/v2.0/plans/update/{planId}
Updates the plan with options
Plans_UpdatePlanWithOptions 1 param body → 200401403404
POST
/bkb/v2.0/plans/search
Searches for account plans based on the criteria
Plans_SearchPlans body → 200401403
GET
/bkb/v2.0/plans/baseplantypes
Gets base plan types
Plans_GetBasePlanTypes → 200401403
GET
/bkb/v2.0/plans/plantypes
Gets plan types for an agency
Plans_GetPlanTypes → 200401403
GET
/bkb/v2.0/plans/departments
Gets departments an agency
Plans_GetDepartments → 200401403
GET
/bkb/v2.0/plans/endingstatuses
Gets plan ending statuses for an agency
Plans_GetEndingStatuses → 200401403
GET
/bkb/v2.0/plans/beginningstatuses
Gets plan beginning statuses for an agency
Plans_GetBeginningStatuses → 200401403
GET
/bkb/v2.0/plans/billingmodes
Gets billing modes for an agency
Plans_GetBillingModes → 200401403
GET
/bkb/v2.0/plans/paymodes
Gets pay modes for an agency
Plans_GetPayModes → 200401403
GET
/bkb/v2.0/plans/customfielddefinitions
Gets the custom field definitions for an agency
Plans_GetCustomFieldDefinitions → 200401403
GET
/bkb/v2.0/plans/{planId}/newhirewaitingperiods
Gets the new hire waiting periods for plan
Plans_GetNewHireWaitingPeriodsForPlan 1 param → 200401403404
GET
/plans/v2.0/plan/{state}/plan
Searches for plans within a given state
Plan_SearchPlans2 5 params → 200400401403404
GET
/plans/v2.0/plan/{planId}/sbc
Gets the SBC for a plan
Sbc_GetSbc2 1 param → 200401403404400502

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are PlanInfo (36 properties), PlanSearchCriteria (33 properties), CustomField (11 properties), PlanInfo_2 (8 properties). Each schema is shown below with its type and property counts.

ValueSearchCriteriaOfInteger
CommissionTypes
string
CommissionTypes
PayMode2
CustomField
object
11 properties
FieldType
string
ValueSearchCriteriaOfDecimal
SearchCriteriaBase
object
2 properties
PlanSearchRequestModel
object
2 properties
ValueSearchCriteriaOfDateTime
StringSearchCriteria
SearchOptions2
object
2 properties
BooleanSearchType
string
EnumSearchType
string
PagedResultOfPlan
object
7 properties
NullableEnumSearchCriteriaOfCommissionType
StringSearchType
string
IdListSearchType
string
DateTimeSearchCriteria
PlanSearchCriteria
object
Search criteria used to search for plans.
33 properties
BasePlanType
object
Base plan type.
2 properties
BeginningSalesTrackingStatuses
string
Plan BeginningSalesTrackingStatuses
EnumSearchCriteriaOfCommissionType
Department2
RateType
string
PlanWithOptionsRequestModel
object
2 properties
SortType
string
CommissionType
string
ProblemDetails
object
6 properties
CustomFieldSearchValue2
object
2 properties
Plan
DecimalSearchCriteria
NullableEnumSearchCriteriaOfRateType
BooleanSearchCriteria
BillingMode2
EndingSalesTrackingStatuses2
string
EndingSalesTrackingStatuses
PlanInfo
object
36 properties
BeginningStatus2
ValueSearchType
string
PlanNewHireWaitingPeriod2
object
Plan New Hire Waiting Period
5 properties
EndingStatus2
NewHireWaitingPeriodRules
string
Available rules for Plan Hew Hire Waiting Periods.
Lookup
object
4 properties
IdListSearchCriteria
CrudOptions
object
2 properties
CustomFieldValue
object
5 properties
EnumSearchCriteriaOfRateType
IntSearchCriteria
RateTypes
string
RateTypes
PlanType
object
BrokerageBuilder Plan Type.
7 properties
Lookup3
object
Agency-defined Plan Lookup
4 properties
ProblemDetails_2
object
5 properties
BenefitItemInfo
object
3 properties 1 required
Plan_2
BenefitItem
PlanAttribute
object
2 properties
BenefitItemValue
BenefitItemValueType
string
SearchResultOfPlan
object
3 properties
BenefitItemTier
string
PlanInfo_2
object
8 properties 7 required
BenefitItemValueInfo
object
4 properties 2 required
ValidationProblemDetails
HttpValidationProblemDetails
PlanType_2
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zywave-plans-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 Plans 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.