Ctrl+K

XBRL API Preview

XBRL API Preview#

The XBRL API allows users to manage XBRL data associated with Workiva documents. XBRL (eXtensible Business Reporting Language) is a standard for digital business reporting used for regulatory filings.

  • XBRL Profile: An XBRL profile is a configuration associated with a document that governs how XBRL tagging is applied. A document may have one or more XBRL profiles.

  • Section XBRL Properties: Each section within a document has XBRL properties that control how the section participates in XBRL tagging (for example, whether XBRL tagging is disabled for that section).

Endpoints#

The XBRL API Preview provides two endpoints:

  • GET /documents/{documentId}/xbrlProfiles — Returns a paginated list of XBRL profiles associated with a document. Supports filtering by archived status.

  • POST /documents/{documentId}/xbrlProfiles/{xbrlProfileId}/sections/batchUpdate — Batch updates XBRL properties for up to 200 sections within a document using JSON Patch operations. Currently supports replacing the xbrlDisabled property on sections.

Using This Preview#

The XBRL API Preview is released as a new version of the Workiva API (see Versioning). To use this feature preview, include an X-Version header with the value 2026-08-01.xbrl.preview on all requests. Then, fetch a bearer token using the POST /oauth2/token endpoint (see Authentication for details). You can then use that token to call any of the new endpoints documented in this API preview.

Preview Status#

This API is a preview capability and may change before general availability. For preview terms, expectations, and lifecycle details, see API Previews at Workiva.