API Documentation
Complete reference for the backq REST API. All endpoints accept and return JSON.
Authentication
API tokens use Bearer authentication
Most endpoints require authentication. Pass your API token in the Authorization header. Generate tokens from your profile page under the API Tokens tab.
Workspace Context
Endpoints that are workspace-scoped require the X-Workspace-Id header. Get your workspace ID from GET /api/workspaces.
Response Format
All endpoints return JSON with a success boolean. Errors include an error string. Data is returned in the data field.
Authentication
Register new accounts and manage authentication sessions.
User Profile
Manage the authenticated user's own profile, password, language preference, and theme.
API Tokens
Create and manage personal API tokens for programmatic access. Tokens use the `bq_` prefix.
Workspaces
Manage workspaces — the top-level organizational unit. Each user gets a personal workspace on registration.
Projects
Manage projects within workspaces. All project endpoints require workspace context via the `X-Workspace-Id` header.
Tickets
Core ticketing system. Create, update, search, and manage tickets. All list endpoints require workspace context.
Files
Download and manage file attachments. The download route provides authenticated, access-checked delivery of attachment bytes.
Timesheet
Track time entries, manage timers, and handle timesheet approval workflows.
Expenses
Submit, manage, and approve expense reports with multi-currency support and file attachments.
Notifications
Retrieve and mark notifications for the authenticated user.
Customer Portal
Endpoints for the customer-facing self-service portal. Customers submit and track their own tickets without a full account.
Health
Infrastructure health check endpoints. No authentication required.
Comments
Edit and delete individual comments.