API Documentation

Build powerful integrations with TaskCheck's REST API

Quick Start

Base URL

https://api.taskcheck.com/v1

Authentication

All API requests require authentication using an API key in the header:

Authorization: Bearer YOUR_API_KEY

Example Request

curl -X GET "https://api.taskcheck.com/v1/tasks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
                    

Tasks

GET /tasks

Retrieve a list of tasks

{
  "data": [
    {
      "id": 1,
      "title": "Complete project proposal",
      "description": "Draft and review the Q1 project proposal",
      "status": "in_progress",
      "priority": "high",
      "due_date": "2024-03-15",
      "created_at": "2024-03-01T10:00:00Z",
      "updated_at": "2024-03-05T14:30:00Z"
    }
  ],
  "meta": {
    "total": 1,
    "per_page": 15,
    "current_page": 1
  }
}
                    

POST /tasks

Create a new task

{
  "title": "New task title",
  "description": "Task description",
  "priority": "medium",
  "due_date": "2024-03-20",
  "assignee_id": 123
}
                    

PUT /tasks/{id}

Update an existing task

{
  "title": "Updated task title",
  "status": "completed",
  "completed_at": "2024-03-10T16:00:00Z"
}
                    

DELETE /tasks/{id}

Delete a task

Users

GET /users

Retrieve a list of users

{
  "data": [
    {
      "id": 123,
      "name": "John Doe",
      "email": "john@example.com",
      "role": "employee",
      "created_at": "2024-01-15T09:00:00Z"
    }
  ]
}
                    

GET /users/{id}

Retrieve a specific user

Teams

GET /teams

Retrieve a list of teams

{
  "data": [
    {
      "id": 1,
      "name": "Development Team",
      "description": "Software development team",
      "member_count": 8,
      "created_at": "2024-01-01T00:00:00Z"
    }
  ]
}
                    

Error Handling

The API uses standard HTTP status codes and returns error details in JSON format:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The given data was invalid.",
    "details": {
      "title": ["The title field is required."],
      "due_date": ["The due date must be a date after today."]
    }
  }
}
            

Rate Limiting

API requests are rate limited to ensure fair usage:

Free Plan: 100 requests per hour
Professional Plan: 1,000 requests per hour
Enterprise Plan: 10,000 requests per hour

Rate limit information is included in response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200
                

SDKs & Libraries

JavaScript/Node.js

npm install taskcheck-api

Python

pip install taskcheck-api

PHP

composer require taskcheck/api

Ruby

gem install taskcheck-api

Need Help?

Our developer support team is here to help you integrate with our API.

Contact Support

Average response time: 2 hours

API Version: v1.0 | Last updated: January 31, 2026

View our API status page for real-time monitoring