API reference
Browse the public methods by workflow. Each method page includes an SDK example, an HTTP equivalent, request parameters, response fields and errors.
| Area | Work with |
|---|---|
| Projects and people | Projects, member lookups, activity and tasks |
| Cases and suites | Repository cases, suites, tags, datasets, reusable steps and revisions |
| Plans and runs | Plans, folders, configurations, assignment and plan cases |
| Execution and evidence | Executions, comments and uploaded evidence |
| Builds, releases and reports | Build traceability, readiness, defects and saved-report results |
Before making a request
Section titled “Before making a request”Create an API token, choose the correct region, and confirm project access.
The SDK examples use 3.35.0. HTTP field names can differ from the SDK’s JavaScript property names; copy the example for the client you use.
Read a workflow before assembling several methods
Section titled “Read a workflow before assembling several methods”A method reference answers how to call one operation. The workflow guides explain which IDs to carry between operations, when to wait for completion, and how to preserve assignment or execution context.
The public SDK can contain methods outside this documented surface. Use the methods in this reference for a new integration and review the compatibility notes when maintaining an existing one.