Written by: Mark Hull, Co-Founder and CEO, Exceeds AI | Last updated: July 7, 2026
Key Takeaways
- Pega developers building custom front-ends need precise DX API references for endpoints, OAuth 2.0 setup, HATEOAS patterns, and v1 vs v2 differences.
- Pega’s official documentation hub is the single maintained source for all DX API technical reference material and is updated directly by Pega.
- The hub covers DX API Overview, Constellation DX API (v2), Traditional DX API (v1), and complete Endpoint Reference documentation.
- Third-party reproductions of Pega DX API content often become outdated, while the official hub reflects current endpoint signatures and authentication requirements.
- Connect your repo and start your free pilot with Exceeds AI to streamline Pega DX API integration.
Why Pega DX API Documentation Needs a Single Source
Pega teams building custom front-ends frequently struggle with scattered, outdated DX API information. Old blog posts, internal wikis, and copied reference tables often conflict with the current platform behavior. These gaps slow delivery and introduce subtle integration bugs.
This guide points you to the single authoritative source for Pega DX API technical reference material. It explains how the official hub is organized and how to use it during design, implementation, and maintenance.
The Solution: Pega’s Official Documentation Hub
Pega’s official documentation site hosts all DX API technical reference material in one place. Endpoint specifications, authentication flows, versioning details, and migration guidance live there and are maintained by Pega.
Pega’s documentation hub organizes DX API material into four core sections that align with your development workflow. You start with the overview to understand the architecture. You then choose between v2 (Constellation) and v1 (Traditional) based on your UI stack. You finally rely on the endpoint reference for implementation details.
- DX API Overview – the starting point for understanding the API surface, architecture, and navigation model.
- Constellation DX API (v2) – the current-generation API for Constellation UI development.
- Traditional DX API (v1) – the prior-generation API, documented for teams maintaining or migrating existing implementations.
- Endpoint Reference – the complete, structured listing of all available endpoints.
The Pega DX API primarily uses OAuth 2.0 authentication via its service package, while also supporting Basic and Custom authentication types. Once authenticated, API responses provide the metadata and links needed to drive subsequent interactions, so your client can navigate the API dynamically.
Why Third-Party DX API References Fall Short
Any third-party reproduction of Pega DX API reference content is redundant and potentially misleading because endpoint signatures, authentication requirements, and versioning details change with each Pega platform release. These changes mean that only Pega’s official documentation hub can reflect the current, maintained state of the API, and third-party sites rarely keep pace.
As a result, relying on secondary summaries risks building against outdated specifications that can fail in production. Teams that copy reference tables into internal documents often miss subtle updates to parameters, response shapes, or authentication flows.
Conclusion: Build Against the Source of Record
Pega platform releases continuously update endpoint signatures, authentication requirements, and supported patterns. The only reliable way to avoid integration errors from outdated specifications is to work directly from Pega’s official documentation hub.
Developers and architects should bookmark the DX API Overview as their canonical starting point. From there, they can navigate to the versioned endpoint reference and authentication guides that match their platform release and project needs.
Ready to accelerate your Pega development? Start your free Exceeds AI pilot today.
Frequently Asked Questions
What is the Pega DX API?
The Pega DX API (Digital Experience API) is the interface Pega provides for building custom front-end applications on top of the Pega platform. It exposes case management, data, and UI metadata through a RESTful surface, which allows developers to construct experiences outside of Pega’s native UI layer. Two versions exist: the Traditional DX API (v1) for existing implementations and the Constellation DX API (v2) for current Constellation-based development.
What is the difference between the Traditional DX API (v1) and the Constellation DX API (v2)?
The Traditional DX API (v1) was designed for Pega’s earlier UI architecture and remains documented for teams maintaining or migrating legacy custom front-ends. The Constellation DX API (v2) is the current-generation interface aligned to Pega’s Constellation design system and architecture. Teams starting new custom front-end projects should build against v2. Teams with existing v1 implementations can consult Pega’s official migration guidance within the documentation hub to understand the path forward.
How does authentication work with the Pega DX API?
Authentication is handled through OAuth 2.0 (the primary method), Basic, or Custom authentication types. The specific grant types, token endpoints, and configuration steps required are documented in full on Pega’s official documentation site. This level of detail matters because authentication configuration is platform-version-sensitive, and what works in one Pega release may fail in the next. For this reason, the official documentation hub is the only reliable source for current setup instructions, and third-party summaries of OAuth configuration details may reflect outdated or incorrect flows that will cause authentication failures.
What does HATEOAS mean in the context of the Pega DX API?
HATEOAS stands for Hypermedia as the Engine of Application State. Some REST APIs use this principle to include hypermedia links in responses that describe available next actions or related resources, rather than requiring the client to construct URLs independently. This approach can reduce tight coupling between the client and the server’s URL structure. Consult Pega’s official documentation for details on how navigation and interactions are handled in the DX API.
Where should engineering teams go for up-to-date DX API endpoint specifications?
The only maintained, authoritative endpoint reference is the Endpoint Reference page within Pega’s official documentation hub. Endpoint signatures, available parameters, and response structures are subject to change across Pega platform releases. Engineering teams should consult the official endpoint reference directly rather than relying on any third-party reproduction, which may reflect a prior platform version and introduce integration errors.