API Reference

Integrate RPMToolbox into your tools and workflows with our REST API.

The RPMToolbox API is a RESTful interface that lets you programmatically manage projects, tasks, documents, and teams. It is the same API that powers our web application, so anything you can do in the UI, you can do via the API.

Base URL

All API requests are made to the following base URL:

https://rpmtoolbox-backend-935512672991.us-central1.run.app/api/v1

Authentication

Most endpoints require a Bearer token in the Authorization header. Obtain a token via /auth/login or /auth/firebase.

Authorization: Bearer <your_access_token>

API Keys

For service-to-service integration, API keys can be generated from your account settings. Include them in the X-API-Key header.

X-API-Key: <your_api_key>

Endpoints

Authentication

MethodPathDescription
POST/auth/registerRegister a new user account
POST/auth/loginLogin with email and password
POST/auth/firebaseLogin with Firebase (Google, Microsoft)
POST/auth/refreshRefresh an expired access token
GET/auth/meGet current user profile

Projects

MethodPathDescription
GET/projectsList all projects you have access to
POST/projectsCreate a new project
GET/projects/{id}Get project details
PUT/projects/{id}Update a project
DELETE/projects/{id}Archive or delete a project

Tasks

MethodPathDescription
GET/tasksList tasks across projects
POST/tasksCreate a new task
GET/tasks/{id}Get task details
PATCH/tasks/{id}Update task status, assignee, etc.

Documents (PRINCE2)

MethodPathDescription
GET/projects/{id}/briefGet Project Brief
PUT/projects/{id}/briefUpdate Project Brief
GET/projects/{id}/business-caseGet Business Case
POST/projects/{id}/documents/generateAI-generate a document draft

Interactive API Docs

Explore the full API with interactive Swagger UI. Try endpoints directly from your browser.

Available in development mode at /docs on the backend.