XQual exposes a full REST API - HTTP and JSON, 400+ methods - so you can drive every action programmatically, build custom integrations, or automate your own workflows on top of XQual.
Everything you can do in the XQual web client, you can do through the API too.
Everything you can do in the XQual web client, you can do through the API too.
- A REST API with 400+ methods covering every action available in XQual,
- HTTP + JSON - no proprietary protocol, works with any language or tool,
- OpenAPI/Swagger-compatible - browse and test every endpoint live,
- Session-cookie or Bearer token authentication - pick what fits your integration,
- Open-source SDK and example client to get started quickly.
The REST API is OpenAPI/Swagger-compatible - browse, test and generate clients directly from the spec. Authenticate with a Bearer token in addition to the classic session cookie. Standard endpoints now return more consistent, modernized JSON formats. And you can test any method live, directly from the documentation, before writing a single line of code.
Everything the Web Client Can Do, You Can Automate
Why, how, and who it's forWhy the REST API
Nothing held back from the web client- Automate anything - creation, updates, queries, deletion - across every entity in XQual (requirements, tests, campaigns, bugs and more)
- Build custom integrations or internal tooling without waiting for a pre-built connector
- Drive XQual from your own scripts, your CI/CD pipeline, or a third-party platform
- Same capabilities as the web client - nothing is held back from the API
How It Works
HTTP, JSON, and a live spec you can test- Every request and response is HTTP + JSON - call it from any language
- Authenticate once (session cookie or Bearer token), then call any of the 400+ methods
-
GETfor reads,POSTfor creates/updates/deletes - Standardized HTTP status codes (200, 400, 403, 404, 500) with a JSON error payload for details
- Explore and test every endpoint live via our OpenAPI/Swagger-compatible documentation
- Open-source SDK and example client (Java) to get started in minutes
Who is this for
From custom tooling to full automation- Teams building custom integrations or internal tooling on top of XQual
- DevOps/platform teams automating XQual as part of a larger toolchain
- Developers who want to explore and test the API live before writing any code
- Both Cloud SaaS and On-Premise XQual customers
Included free with every XQual license.