API Getting Started

The Biztraak API gives you programmatic access to supported projects, components, deployments, and other platform workflows.
This guide walks you through authenticating, making your first request, and exploring the API schema.

Prerequisites

• A Biztraak account with an active workspace
• An API token (JWT) from Biztraak’s identity provider (FoxIDs / OAuth 2.0)
• A REST client such as cURL, Postman or Insomnia, or a GraphQL client such as GraphiQL, Insomnia, or Apollo Sandbox

Authentication

All API requests must be authenticated with a Bearer token.

1. Log into the Biztraak dashboard
2. Go to Profile → API Tokens
3. Generate a new token

Include the token in the header of every request:

Authorization: Bearer <your-token>

API Endpoints

Use the API host for the environment you connected to. Replace <api-host> below with that environment-specific host.

• GraphQL API

  • https://<api-host>/graphql → main endpoint for queries and mutations
  • wss://<api-host>/graphql → WebSocket transport for subscriptions
  • https://<api-host>/graphql-voyager → interactive schema explorer

• REST API

  • https://<api-host>/swagger → generated Swagger UI for the main web REST API
  • Route families such as /api/projects/v1, /api/teams/v1, /api/devops/v1, and /api/marketplace/v1 → direct REST calls

First Request (GraphQL)

Start with a read-only project query. The projects connection supports the standard GraphQL connection shape, including first and nodes:

query ListProjects {
  projects(first: 10) {
    nodes {
      id
      name
    }
  }
}

Run it with curl:

curl -X POST https://<api-host>/graphql \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query":"query ListProjects { projects(first: 10) { nodes { id name } } }"}'

To create a project, inspect the live AddProjectInput type first. The current mutation requires a team, project name, and the other input fields exposed by the schema. project creation is also subject to team authorization and billing or provider requirements.

Exploring the Schema

• GraphQL Voyager: browse the schema visually at /graphql-voyager
• GraphiQL and other clients: connect an external client to /graphql. Biztraak does not currently host an embedded GraphiQL page
• Introspection: inspect the live schema or generate typed clients from the GraphQL schema when your client and environment permit it
• Swagger/OpenAPI: inspect the generated REST contract at /swagger

For request structure, subscriptions, authorization, and client guidance, see the GraphQL guide.

Tips

• Store tokens in environment variables ($TOKEN) for safety
• Use Audit Logs to track API calls for compliance
• Combine API calls with CI/CD for automation

Next steps

• Authentication → learn how token issuance and refresh work
• Authorization → see how RBAC applies to API calls
• Swagger/OpenAPI and REST tools → inspect the generated REST contract and use route examples
• API operations → retries, asynchronous work, and compatibility guidance

With authentication set up, you’re ready to automate Biztraak with API calls, from creating projects to deploying apps through supported deployment workflows.