API Reference

Complete reference for the Adaptavist REST API. All endpoints are relative to your instance base URL, e.g. https://your-instance.adaptavist.net/api/v1.

Authentication

All requests must include a Bearer token in the Authorization header. Generate a personal API token from your account settings.

Authorization: Bearer <your-api-token>

Projects

List projects

Returns a paginated list of all projects the authenticated user has access to.

{
  "projects": [
    { "id": "PRJ-1", "key": "PRJ", "name": "My Project", "lead": "user@example.com" }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20
}

Get project

Returns a single project by its ID or key.

Workflows

List workflows

Returns all workflows associated with the specified project.

Trigger workflow

Manually triggers a workflow run. The request body accepts an optional inputs object whose keys match the workflow's declared input parameters.

{
  "inputs": {
    "environment": "staging",
    "notify": true
  }
}

Error Codes

All error responses follow a consistent shape:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Project PRJ-999 does not exist.",
    "status": 404
  }
}