For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Integration Example (PSA)
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Workflows Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
On this page
  • How to use the API Reference
  • Main Feature Areas
  • API v1

API Reference

Was this page helpful?
Edit this page
Previous

Projects

Next
Built with

This API Reference lists all entities and operations supported by the awork API v1.

How to use the API Reference

The endpoints are grouped by feature area. At the beginning of each section there is an introduction to the general concepts that are important to understand when working with these endpoints. Each endpoint includes a brief description of the resource, the operations supported, and the request and response formats as well as example values.

If you have any questions or need help, please contact us in the Developer Forum.

Main Feature Areas

These are the main feature areas in awork and the corresponding API endpoints:

Projects

Projects are the core entity in awork and represent a collection of tasks and other resources.

Tasks

Tasks are the smallest unit of work in awork and represent work to be done.

Time Tracking

Time Tracking and the resulting Time Entries allow projects to be billed.

Companies

Projects are usually connected to Companies (Clients).

Users

Users, Teams and Roles form the basis of awork’s permission management.

Workload & Planning

Workload, commited work and user capacities help with Project Planning.

API v1

This is the first and default version of the awork API. It is a RESTful API that uses JSON for serialization and OAuth 2.0 for authentication. The API is designed to be easy to use and to provide a consistent interface for all clients.