PUBLIC ALPHABiztraak is now in public alpha. Share feedback
Biztraak

API Overview

Biztraak exposes programmatic surfaces so teams can automate workflows that would otherwise be handled manually through the product. This guide explains where automation fits, how to get started safely, and how to choose between GraphQL and REST. For GraphQL queries, mutations, subscriptions, Voyager, and external GraphiQL clients, see the GraphQL guide.

What the API is for

Use the API when you want Biztraak to participate in a wider engineering workflow: automation, integration, internal tooling, scripted project operations, or platform-connected delivery processes.

Automate project work when manual UI interaction is not the right operational path.

Integrate Biztraak into internal tools, platform workflows, and supporting delivery systems.

Stay aligned with product behavior because the API is meant to map to real platform actions rather than a separate hidden control plane.

Start here to understand how the API fits into Biztraak workflows. Use the linked authentication and reference pages when you are ready to connect a specific workflow.

What users typically automate

Teams usually reach for the API when they want to automate one or more of these areas:

  • project and component workflows
  • deployment or runtime-related checks
  • integration with surrounding engineering systems
  • operational reporting or scripted environment actions
  • platform-connected internal tooling

If you can already reason about a workflow in the Biztraak UI, the API is the route for making that workflow part of a broader system.

Getting started path

A practical first path looks like this:

  1. Understand the workflow you want to automate in the product first.
  2. Set up authentication and token handling.
  3. Make a small first request against a simple, observable workflow from API Getting Started.
  4. Expand toward more structured project, deployment, or platform automation.

Start with the linked workflow guides, then use the GraphQL, REST API reference, and API errors pages when you need protocol-level details.

Public-facing scope

API support varies by workflow. Review the linked documentation for advanced compliance, agent, and specialty runtime workflows before treating them as production-ready automation paths.

Confirm the target workflow's authentication, operations, and support requirements in its linked guide before automating it in production.

Next steps

API Getting Started

Follow the first practical path for working with Biztraak programmatically.

Authentication

Set up token-based access before making real API requests.

Authorization

Understand how access rules and role-based permissions affect API usage.

Swagger/OpenAPI and REST

Inspect the generated REST contract and use route examples.

REST API

Review route families, request examples, and asynchronous operation behavior.

API errors

Handle HTTP, ProblemDetails, GraphQL, and workflow failures.

API operations

Plan retries, asynchronous workflows, and compatibility changes.