API Reference

Getting Started

Authentication & Essentials

🔑

Authentication

All API requests require a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

API keys are available in your CompleteDigi client portal under Settings → API Keys.

⚡

Rate Limits

API rate limits by tier:

Free / Sandbox: 100 req/min
Growth: 1,000 req/min
Enterprise: 10,000 req/min

Rate limit headers: X-RateLimit-Limit, X-RateLimit-Remaining

📋

Response Format

All responses return JSON. Successful responses use HTTP 2xx. Error responses include error.code and error.message.

Content-Type: application/json

Pagination uses cursor-based navigation via next_cursor and limit parameters.

Endpoints

API Endpoint Reference

Projects

GET /projects List all projects

Returns a paginated list of all projects associated with your account.

Example Request

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

Response

{
  "data": [
    {
      "id": "proj_01HXYZ...",
      "name": "Payment Gateway Rebuild",
      "status": "active",
      "created_at": "2025-01-15T08:00:00Z"
    }
  ],
  "next_cursor": "cursor_...",
  "has_more": true
}

POST /projects Create a new project

GET /projects/:id Retrieve a project

PATCH /projects/:id Update a project

Milestones

GET /projects/:id/milestones List project milestones

PUT /milestones/:id/status Update milestone status

Reports & Analytics

GET /reports/velocity Sprint velocity report

GET /reports/budget Budget utilisation report

POST /webhooks Register a webhook endpoint

SDKs

Official Client Libraries

Use our official SDKs to integrate in minutes, not hours.

🟨

JavaScript / TypeScript

npm install @completedigi/sdk

Full TypeScript types included. Supports Node.js 18+ and all major browsers.

🐍

Python

pip install completedigi

Python 3.9+. Async support with asyncio. Works with FastAPI and Django.

🐹

Go

go get github.com/completedigi/go-sdk

Idiomatic Go with context support. Thread-safe. Used in our own infrastructure.