# Zywave Plans API

**Canonical:** https://apis.io/apis/zywave/zywave-plans-api/  
**Provider:** Zywave — https://apis.io/providers/zywave/  
**Base URL:** https://api.zywave.com  
**Documentation:** https://www.zywave.dev/apis/

Zywave Plans API is one of 84 APIs that [Zywave](https://apis.io/providers/zywave/) publishes on the [APIs.io](https://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.

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

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/bkb/v2.0/plans/{planId}` | Gets the account plan (planhistory) by id |
| PUT | `/bkb/v2.0/plans/update/{planId}` | Updates the plan with options |
| POST | `/bkb/v2.0/plans/search` | Searches for account plans based on the criteria |
| GET | `/bkb/v2.0/plans/baseplantypes` | Gets base plan types |
| GET | `/bkb/v2.0/plans/plantypes` | Gets plan types for an agency |
| GET | `/bkb/v2.0/plans/departments` | Gets departments an agency |
| GET | `/bkb/v2.0/plans/endingstatuses` | Gets plan ending statuses for an agency |
| GET | `/bkb/v2.0/plans/beginningstatuses` | Gets plan beginning statuses for an agency |
| GET | `/bkb/v2.0/plans/billingmodes` | Gets billing modes for an agency |
| GET | `/bkb/v2.0/plans/paymodes` | Gets pay modes for an agency |
| GET | `/bkb/v2.0/plans/customfielddefinitions` | Gets the custom field definitions for an agency |
| GET | `/bkb/v2.0/plans/{planId}/newhirewaitingperiods` | Gets the new hire waiting periods for plan |
| GET | `/plans/v2.0/plan/{state}/plan` | Searches for plans within a given state |
| GET | `/plans/v2.0/plan/{planId}/sbc` | Gets the SBC for a plan |

## Machine-readable artifacts (62)

- **OpenAPI** — https://artifacts.apis.io/zywave/openapi/zywave-plans-api-openapi.yml
- **Documentation** — https://www.zywave.dev/apis/
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-account-contact-info-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-account-info-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-account-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-account-contact-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-account-external-reference-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-account-contact-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-account-contact-driver-info-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-account-contact-driver-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-agency-user-info-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-agency-user-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-agency-user-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-agency-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-agency-collection-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-activity-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-carrier-contact-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-commission-schedule-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-broker-contact-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-plan-rate-metadata-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-file-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-carrier-company-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-carrier-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-carrier-company-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-carrier-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-invite-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-employee-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-tool-package-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-employee-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-tool-package-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-employee-group-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-company-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-loss-event-details-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-company-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-program-assessment-search-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-loss-event-data-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-rpm-data-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-download-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-content-schema.json
- **JSONSchema** — https://artifacts.apis.io/zywave/json-schema/zywave-content-aggregation-schema.json
- …and 22 more, listed in full on the page.

## Other Zywave APIs (12)

- [Zywave Account API](https://apis.io/apis/zywave/zywave-account-api/)
- [Zywave Account Contact API](https://apis.io/apis/zywave/zywave-accountcontact-api/)
- [Zywave Account Contact Driver API](https://apis.io/apis/zywave/zywave-accountcontactdriver-api/)
- [Zywave Account Contacts API](https://apis.io/apis/zywave/zywave-accountcontacts-api/)
- [Zywave Account External Reference API](https://apis.io/apis/zywave/zywave-accountexternalreference-api/)
- [Zywave Accounts API](https://apis.io/apis/zywave/zywave-accounts-api/)
- [Zywave Activation API](https://apis.io/apis/zywave/zywave-activation-api/)
- [Zywave Activities API](https://apis.io/apis/zywave/zywave-activities-api/)
- [Zywave Agency API](https://apis.io/apis/zywave/zywave-agency-api/)
- [Zywave Agency Data API](https://apis.io/apis/zywave/zywave-agency-data-api/)
- [Zywave Agency User API](https://apis.io/apis/zywave/zywave-agencyuser-api/)
- [Zywave Assessment API](https://apis.io/apis/zywave/zywave-assessment-api/)

## Tags

Plans

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/zywave/zywave-plans-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/zywave/.
