TaskLeef API दस्तावेज़

टूडू, प्रोजेक्ट और kanban बोर्ड प्रबंधित करने के लिए REST API

अंतिम बार अपडेट किया गया:

− प्रमाणीकरण

API दो प्रमाणीकरण विधियों का समर्थन करता है:

1. API कुंजी प्रमाणीकरण (अनुशंसित)

Generate an API key from your Settings page and include it in the X-API-Key header:

curl -H "X-API-Key: your-api-key" \
  https://taskleef.com/api/todos

2. JWT बियरर टोकन

ब्राउज़र-आधारित अनुप्रयोगों के लिए, लॉगिन एंडपॉइंट के माध्यम से प्रमाणित करें:

curl -X POST https://taskleef.com/api/login \
  -H "Content-Type: application/json" \
  -d '{"username": "your-username", "password": "your-password"}'

फिर बाद के अनुरोधों में टोकन शामिल करें:

curl -H "Authorization: Bearer your-jwt-token" \
  https://taskleef.com/api/todos

− टूडू

GET/api/todos

प्रमाणित उपयोगकर्ता के लिए सभी टूडू प्राप्त करें।

curl -H "X-API-Key: your-api-key" \
  https://taskleef.com/api/todos
GET/api/todos/{id}

ID द्वारा एक विशिष्ट टूडू प्राप्त करें।

GET/api/inbox

ऐसे टूडू प्राप्त करें जो किसी प्रोजेक्ट को असाइन नहीं हैं।

POST/api/todos

एक नया टूडू बनाएँ।

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Buy groceries", "description": "Milk, eggs, bread"}' \
  https://taskleef.com/api/todos

अनुरोध बॉडी

फ़ील्डप्रकारआवश्यकविवरण
titlestringYesTodo title
descriptionstringNoDetailed description
dueDateISO 8601NoDue date/time
prioritystringNoLow, Medium, High, or Urgent
projectIdUUIDNoAssign to a project
PUT/api/todos/{id}

मौजूदा टूडू अपडेट करें।

PATCH/api/todos/{id}/complete

टूडू की पूर्णता स्थिति टॉगल करें।

curl -X PATCH -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"isCompleted": true}' \
  https://taskleef.com/api/todos/{id}/complete
DELETE/api/todos/{id}

एक टूडू हटाएँ।

POST/api/todos/{parentId}/subtasks

किसी मूल टूडू के अंतर्गत एक सबटास्क बनाएँ।

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Subtask title"}' \
  https://taskleef.com/api/todos/{parentId}/subtasks

− प्रोजेक्ट

GET/api/projects

प्रमाणित उपयोगकर्ता के लिए सभी प्रोजेक्ट सूचीबद्ध करें।

POST/api/projects

एक नया प्रोजेक्ट बनाएँ।

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Work Tasks", "description": "Tasks for work"}' \
  https://taskleef.com/api/projects
GET/api/projects/{id}

एक विशिष्ट प्रोजेक्ट उसके टूडू सहित प्राप्त करें।

PUT/api/projects/{id}

एक प्रोजेक्ट अपडेट करें।

DELETE/api/projects/{id}

एक प्रोजेक्ट हटाएँ (टूडू इनबॉक्स में ले जाए जाते हैं)।

− Kanban बोर्ड

GET/api/boards

उन सभी बोर्ड को सूचीबद्ध करें जिन तक उपयोगकर्ता की पहुँच है।

POST/api/boards

एक नया बोर्ड बनाएँ।

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "Sprint Board", "projectId": "project-uuid"}' \
  https://taskleef.com/api/boards
GET/api/boards/{id}

एक विशिष्ट बोर्ड प्राप्त करें।

GET/api/boards/{boardId}/columns

किसी बोर्ड के सभी कॉलम प्राप्त करें।

GET/api/boards/{boardId}/todos

इस बोर्ड पर कार्ड वाले सभी टूडू प्राप्त करें।

− कॉलम

POST/api/boards/{boardId}/columns

किसी बोर्ड पर एक नया कॉलम बनाएँ।

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"title": "In Progress", "wipLimit": 3}' \
  https://taskleef.com/api/boards/{boardId}/columns
PUT/api/columns/{id}

एक कॉलम अपडेट करें (शीर्षक, WIP सीमा, पूर्णता मानदंड)।

GET/api/columns/{columnId}/cards

किसी कॉलम के सभी कार्ड प्राप्त करें।

DELETE/api/columns/{id}

एक कॉलम हटाएँ।

− कार्ड

कार्ड kanban बोर्ड पर टूडू का प्रतिनिधित्व करते हैं। एक टूडू के कई बोर्ड पर कार्ड हो सकते हैं।

POST/api/columns/{columnId}/cards

किसी कॉलम में किसी टूडू के लिए एक कार्ड बनाएँ।

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"todoId": "todo-uuid"}' \
  https://taskleef.com/api/columns/{columnId}/cards
PUT/api/cards/{id}

एक कार्ड अपडेट करें (अलग कॉलम या subColumn में ले जाएँ)।

# Move card to a different column
curl -X PUT -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"columnId": "new-column-uuid", "subColumn": "Inbox"}' \
  https://taskleef.com/api/cards/{id}

# Move card to Done subColumn
curl -X PUT -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"subColumn": "Done"}' \
  https://taskleef.com/api/cards/{id}

SubColumn मान

  • Inbox - Active items in the column
  • Done - Completed items within the column
  • Blocked - Items waiting on external dependencies
DELETE/api/cards/{id}

बोर्ड से एक कार्ड हटाएँ (टूडू नहीं हटता)।

− टैग

GET/api/tags

प्रमाणित उपयोगकर्ता के लिए सभी टैग सूचीबद्ध करें।

POST/api/tags

एक नया टैग बनाएँ।

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "urgent"}' \
  https://taskleef.com/api/tags
PUT/api/tags/{id}

एक टैग अपडेट करें।

DELETE/api/tags/{id}

एक टैग हटाएँ।

− टिप्पणियाँ

GET/api/todos/{todoId}/comments

किसी टूडू की सभी टिप्पणियाँ प्राप्त करें।

POST/api/todos/{todoId}/comments

किसी टूडू में एक टिप्पणी जोड़ें।

curl -X POST -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"text": "This is my comment"}' \
  https://taskleef.com/api/todos/{todoId}/comments
PUT/api/comments/{id}

एक टिप्पणी अपडेट करें।

DELETE/api/comments/{id}

एक टिप्पणी हटाएँ।

− प्रतिक्रिया प्रारूप

सफल प्रतिक्रियाएँ

सफल अनुरोध अनुरोधित डेटा के साथ JSON लौटाते हैं:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "title": "Buy groceries",
  "description": "Milk, eggs, bread",
  "isCompleted": false,
  "createdAt": "2024-01-15T10:30:00Z"
}

त्रुटि प्रतिक्रियाएँ

त्रुटियाँ उपयुक्त HTTP स्थिति कोड लौटाती हैं:

  • 400 - Bad Request (invalid input)
  • 401 - Unauthorized (missing or invalid authentication)
  • 403 - Forbidden (insufficient permissions)
  • 404 - Not Found
  • 500 - Internal Server Error

Need help? Check your Settings to manage API keys.