رابط برنامه‌نویسی

مستندات API تسکیـ برای یکپارچه‌سازی با ابزارهای سازمان

رابط برنامه‌نویسی RESTful برای یکپارچه‌سازی تسکیـ با ابزارهای داخلی سازمان، سیستم‌های خارجی و اتوماسیون فرآیندها.
  • HTTPS + JSON
  • Bearer Token
  • Rate Limiting
  • Webhooks

پیش از اولین درخواست آنچه باید بدانید

۰۱ امنیت

احراز هویت

از «تنظیمات › توکن‌های API» یک توکن شخصی بسازید و آن را به‌صورت Bearer در هدر Authorization هر درخواست بفرستید. هر توکن به‌جای شما و فقط با دسترسی‌هایی که انتخاب کرده‌اید عمل می‌کند و هر زمان می‌توانید باطلش کنید.

Authorization: Bearer {token}

۰۲ پایداری

محدودیت نرخ

به‌منظور پایداری سرویس، محدودیت نرخ درخواست اعمال می‌شود. در صورت تجاوز، پاسخ 429 دریافت می‌کنید.

عمومی
60 req/min
جستجو
30 req/min
آپلود
10 req/min

۰۳ قرارداد

قراردادهای پایه

  • URL پایه: https://app.taskie.ir/api/v1
  • تمام پاسخ‌ها به فرمت JSON هستند
  • شناسه‌ها رشته‌های کوتاه و مبهم‌اند، همان‌هایی که در لینک‌های تسکی می‌بینید
  • تاریخ‌ها به فرمت ISO 8601
  • خطاها با کد HTTP مناسب برگردانده می‌شوند

نمونه درخواست و پاسخ

دریافت فهرست وظایف یک پروژه، ۲۰ مورد در هر صفحه
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": "طراحی رابط کاربری داشبورد",
      "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 و منابع در دسترس

منابع اصلی در دسترس از طریق API

فضاهای کاری

مدیریت فضای کاری، اعضا و تنظیمات

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

پروژه‌ها

ساخت، ویرایش و آرشیو پروژه‌ها

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

وظایف

کامل‌ترین API برای مدیریت وظایف

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

اسپرینت

چرخه‌های اسپرینت و گزارش‌های چابک

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

نقشه ذهنی

فهرست نقشه‌های ذهنی پروژه

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

اهداف (OKR)

ساخت، خواندن و ویرایش اهداف

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

اتوماسیون

قوانین خودکار و اجرای تریگرها

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

اعضا و دعوت‌نامه

اعضای فضای کاری و پروژه، و دعوت‌نامه‌ها

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

دسترسی به API، از تنظیمات شروع می‌شود

از «تنظیمات › توکن‌های API» یک توکن شخصی بسازید، دسترسی‌هایش را انتخاب کنید و فراخوانی API را شروع کنید. مرجع OpenAPI همه‌ی مسیرها را با فیلدها و دسترسی‌هایشان فهرست می‌کند.

/api-docs/openapi.json