API Endpoints Reference
The Doclio API provides endpoints for reading and managing your project data.
Projects
| Method | Endpoint | Description |
|---|---|---|
GET |
/projects |
List all projects. Filter with ?status= or ?archived=true|false |
GET |
/projects/:id |
Get a specific project |
Drawings
| Method | Endpoint | Description |
|---|---|---|
GET |
/projects/:id/drawings |
List all drawings in a project |
Annotations
| Method | Endpoint | Description |
|---|---|---|
GET |
/projects/:id/annotations |
List all annotations in a project. Filter with ?status=, ?type=, ?priority=, ?assigned_to= |
GET |
/annotations/:id |
Get a specific annotation, including its comments |
PATCH |
/annotations/:id |
Update an annotation. Updatable fields: status, priority, assigned_to, title, description, due_date |
Annotations cannot be created or deleted via the API — only read and updated.
Authentication
All endpoints use the x-api-key header for authentication. API keys are scoped to your organisation and respect the scopes assigned during creation.
Pagination and Response Shape
List endpoints support pagination via query parameters: ?page=1&per_page=25 (default: 25 per page, max: 100).
List responses return the records in data with pagination details in meta:
{
"data": [ ... ],
"meta": { "total": 132, "page": 1, "per_page": 25 }
}Single-record responses return the record in data. Errors return an error field.