API

Taskie API docs for integrating with your organization's tools

A RESTful API for integrating Taskie with your organization's internal tools and external systems, and for automating processes.
  • HTTPS + JSON
  • Bearer Token
  • Rate Limiting
  • Webhooks

Before your first request, what you need to know

01 Security

Authentication

Create a personal token under Settings › API tokens and send it as a Bearer token in the Authorization header of every request. Each token acts as you, limited to the access you choose, and you can revoke it at any time.

Authorization: Bearer {token}

02 Stability

Rate limits

To keep the service stable, requests are rate-limited. If you go over the limit, you get a 429 response.

General
60 req/min
Search
30 req/min
Upload
10 req/min

03 Conventions

Basic conventions

  • Base URL: https://app.taskie.ir/api/v1
  • Every response is JSON
  • IDs are short opaque strings, the same ones you see in Taskie links
  • Dates use ISO 8601
  • Errors come back with the matching HTTP status code

Sample request and response

Fetch a project's tasks, 20 per page
RequestcURL
curl -X GET \
  "https://app.taskie.ir/api/v1/tasks?project_id=a1B2c3&per_page=20" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"
Response200 OK
{
  "data": [
    {
      "id": "gxZ4kAqW",
      "formatted_id": "ENG-142",
      "title": "Design the dashboard UI",
      "status_id": "kL9mN0",
      "assignee_id": "pQ7rS2",
      "priority": 4,
      "end_at": "2026-04-15T00:00:00+00:00"
    }
  ],
  "links": { "next": "https://app.taskie.ir/api/v1/tasks?cursor=eyJpZCI6MTQyfQ", "prev": null },
  "meta": { "request_id": "req_01HXYZ", "api_version": "v1", "per_page": 20 }
}

API groups and available resources

The main resources available through the API

Workspaces

Manage workspaces, members and settings

  • GET/workspaces
  • POST/workspaces
  • PATCH/workspaces/{id}
  • GET/workspaces/{id}/statuses

Projects

Create, edit and archive projects

  • GET/projects
  • POST/projects
  • GET/projects/{id}
  • PATCH/projects/{id}

Tasks

The most complete API, for managing tasks

  • GET/tasks?project_id={id}
  • POST/tasks
  • GET/tasks/{id}
  • PATCH/tasks/{id}
  • POST/tasks/{id}/status
  • DELETE/tasks/{id}

Sprints

Sprint cycles and agile reports

  • GET/projects/{id}/sprints
  • POST/projects/{id}/sprint-folders/{folder}/sprints
  • POST/projects/{id}/sprints/{sprint}/start

Mind maps

List a project's mind maps

  • GET/projects/{id}/mind-maps

Goals (OKRs)

Create, read and update goals

  • GET/goals
  • POST/goals
  • GET/goals/{id}
  • PATCH/goals/{id}

Automations

Automation rules and trigger runs

  • GET/automations
  • POST/automations
  • POST/automations/{id}/toggle

Members and invitations

Workspace and project members, and invitations

  • GET/workspaces/{id}/members
  • GET/projects/{id}/members
  • POST/workspaces/{id}/invitations

API access, starts in your settings

Create a personal token in Settings › API tokens, choose what it may access, and start calling the API. The OpenAPI reference lists every endpoint with its fields and scopes.

/api-docs/openapi.json