# Kanbert API Documentation

Welcome to the Kanbert Developer Hub.
Here you’ll find everything you need to integrate with the Kanbert API—from authentication and permissions to powerful filtering, aggregates, and advanced data queries.

Our API is designed to be **predictable**, **type-safe**, and **flexible**, supporting simple CRUD use cases as well as complex reporting queries.

If you're new here, start with **Authentication** and **Scopes**, then explore the advanced features such as **Filtering** and **Computed Fields**.

# 🚀 Quick Start

1. **Create an API token** or configure OAuth.
2. **Choose your permissions** using scopes.
3. Use the REST API to read and update Kanbert data:

```
GET /api/v1/projects?filter=status eq "ACTIVE"
```
4. Explore computed fields and relation filters to create rich data queries.


# 📚 Documentation Sections

Below are the core sections of the Kanbert API documentation.
Click on any card to open the full page.

# 📦 Core Concepts

| Section | Description |
|  --- | --- |
| **[Authentication](/authentication)** | How to authenticate using API tokens or OAuth. Includes examples for all major HTTP clients. |
| **[Scopes & Permissions](/scopes)** | Learn how scopes control access, how `integration` mode works, and how permissions differ when acting as a user vs. system identity. |
| **[Entities & Data Model](/api/schemas)** | Overview of major API resources such as Users, Projects, Clients, Tasks, and more. |


# 🔍 Querying & Filtering

| Section | Description |
|  --- | --- |
| **[Filtering](/filtering)** | Learn how to use the `filter` query parameter, JSON and DSL syntax, operators, type rules, relation filters, and practical examples. |
| **[Computed Fields](/computed-fields)** | Create per-request aggregates with `computed_fields[...]` and use them for filtering and sorting. Includes examples for `count`, `sum`, `avg`, and more. |


# 🧩 Endpoints

Projects API
Read, create, update, and filter projects. Includes examples with complex filters and computed fields.

Tasks API
Work with tasks, phases, statuses, and assignees. Includes relation filtering examples.

Clients API
Retrieve and manage client records. Supports filtering and relation-based queries.

Efforts API
Retrieve efforts booked on projects

# ✨ About This API

* **RESTful** JSON endpoints
* **Consistent filtering, sorting, and relationships** across all resources
* **Powerful query capabilities** via DSL, relation operators, and computed fields
* Designed for both **simple integrations** and **complex reporting / analytics use cases**


# ❓ Need Help?

* Check our **FAQ** in each section
* Contact Kanbert support for integration assistance
* Submit issues or feedback through Kanbert support