API Reference

Comprehensive documentation for integrating with TotalChecklist's powerful APIs. Build custom integrations and automate your workflows.

99.9%
API Uptime
<100ms
Response Time
50+
API Endpoints
10K/min
Rate Limit

API Endpoints

GET/api/v1/projects

Retrieve all projects

POST/api/v1/projects

Create a new project

GET/api/v1/tasks

Retrieve tasks

POST/api/v1/analytics/events

Track custom analytics events

Endpoint Details

GET/api/v1/projects

Retrieve all projects

Parameters

pageinteger

Page number for pagination

limitinteger

Number of items per page (max 100)

statusstring

Filter by project status

Response Example

{
  "data": [
    {
      "id": "proj_123",
      "name": "Mobile App Redesign",
      "description": "Complete redesign of mobile application",
      "status": "active",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "pages": 3
  }
}

Official SDKs

Get started quickly with our official SDKs and libraries

JavaScript/TypeScript

Official SDK for web and Node.js applications

Installation

npm install @totalchecklist/sdk

Example Usage

import { TotalChecklistAPI } from '@totalchecklist/sdk';

const api = new TotalChecklistAPI({
  apiKey: 'your_api_key_here',
  baseURL: 'https://api.totalchecklist.com'
});

// Get all projects
const projects = await api.projects.list();

// Create a new task
const task = await api.tasks.create({
  title: 'New task',
  project_id: 'proj_123'
});

Python

Python SDK for backend integrations

Installation

pip install totalchecklist-python

Example Usage

from totalchecklist import TotalChecklistAPI

api = TotalChecklistAPI(api_key='your_api_key_here')

# Get all projects
projects = api.projects.list()

# Create a new task
task = api.tasks.create(
    title='New task',
    project_id='proj_123'
)

REST API

Direct HTTP API calls

Installation

curl or any HTTP client

Example Usage

curl -X GET "https://api.totalchecklist.com/v1/projects" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json"

curl -X POST "https://api.totalchecklist.com/v1/tasks" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "New task",
    "project_id": "proj_123"
  }'

Authentication

API Key Authentication

All API requests must include your API key in the Authorization header:

Authorization: Bearer your_api_key_here

Getting Your API Key

Generate your API key from the Settings → API section in your TotalChecklist dashboard. Keep your API key secure and never share it publicly.

Rate Limits

Starter

1,000 requests/hour
Sustained rate
100 requests/minute
Burst rate

Professional

10,000 requests/hour
Sustained rate
500 requests/minute
Burst rate

Enterprise

Custom limits
Sustained rate
Custom burst
Burst rate