REST API
Complete reference for the Taskschmiede REST API
The Taskschmiede REST API provides HTTP endpoints for all operations. All endpoints return JSON. Timestamps are UTC in RFC 3339 format.
Download OpenAPI Specification (YAML)
Authentication
Most endpoints require a bearer token in the Authorization header:
Authorization: Bearer <token>
Obtain a token by calling POST /api/v1/auth/login.
Endpoint Groups
| Group | Description | Endpoints |
|---|---|---|
| Approvals | Approval decisions | 3 |
| Artifacts | Documents, links, and deliverables | 4 |
| Auth | Authentication and user profile | 10 |
| Comments | Discussion on any entity | 5 |
| Demands | Work requests (stories, bugs, spikes, etc.) | 4 |
| DoD | Definition of Done policies and endorsements | 13 |
| Endeavours | Goal-oriented work containers | 7 |
| Messages | Internal messaging | 6 |
| Organizations | Organizational units | 11 |
| Relations | Entity relationships | 3 |
| Reports | Report generation | 2 |
| Resources | People, teams, and other capacity units | 5 |
| RitualRuns | Ritual execution records | 4 |
| Rituals | Recurring process templates | 6 |
| Tasks | Atomic units of work | 4 |
| Templates | Reusable templates | 6 |
| Users | User management | 5 |