Code Generation

Disclaimer

We make no commitments to support code generated by 3rd party tools, or to ensure that any bindings generated from our OAS will be backwards-compatible with any bindings from previous OAS versions.

We promise that our APIs will not contain any deliberate breaking changes, except in the case of major version revisions. However, we do not extend this guarantee to the bindings generated from our OpenAPI Specification (OAS). As we cannot control these bindings, breaking changes may occur without notice.

The Workiva 2022-01-01 (default) API is specified using OpenAPI, and can be downloaded.

Generating client libraries using OpenAPI Generator

To talk to the Workiva 2022-01-01 (default) API via a client library, use the OpenAPI Generator project.

Client libraries can be generated for more than 25 languages, and client code is language-specific; consult the README and usage examples of the generated code.

Attention

OpenAPI Generator is a third-party, open-source tool. As each client varies in their levels of support and available features and options, some generators may not support specific schema object names. We recommend you rename any schema objects in your copy of the OpenAPI spec that are incompatible with your generator.