DocumentationAPI ReferenceIntegrationsSDKs & ToolsComing Soon
Sign InBack to Main Site
REST API

API Reference

Build powerful integrations with the Paperless API. Access projects, milestones, documents, and more through our RESTful endpoints.

RESTful Design

Clean, predictable endpoints following REST conventions with JSON responses.

Secure by Default

OAuth 2.0 authentication, API keys, and webhook signatures for security.

Real-time Webhooks

Subscribe to events and get notified instantly when data changes.

Rate Limiting

Fair usage limits with clear headers and upgrade paths for higher limits.

Quick Start

Get up and running in minutes with our SDKs and code examples.

javascript
// Install: npm install @paperless/sdk
import { Paperless } from '@paperless/sdk';

const client = new Paperless({
  apiKey: process.env.PAPERLESS_API_KEY
});

// Fetch all projects
const projects = await client.projects.list();

// Create a milestone
const milestone = await client.milestones.create({
  projectId: 'proj_123',
  name: 'Foundation Complete',
  dueDate: '2024-03-15'
});

API Endpoints

Core endpoints for managing projects and construction data.

GET/v1/projects
POST/v1/projects
GET/v1/projects/{id}
GET/v1/projects/{id}/milestones
POST/v1/milestones
PATCH/v1/milestones/{id}
GET/v1/documents
POST/v1/documents

Base URL

https://api.buildpaperless.com.au/v1