REST API
Complete reference for the DocKit REST API endpoints.
Base URL
All API requests are made to the following base URL:
HTTP
https://api.dockit.dev/v3
Authentication
Authenticate by passing your API key in the Authorization header:
HTTP
GET /v3/projects HTTP/1.1
Host: api.dockit.dev
Authorization: Bearer dk_live_xxxxxxxxxxxx
Content-Type: application/json
Endpoints
- GET
/projects— List all projects in the authenticated account. - POST
/projects— Create a new project. - GET
/projects/:id— Retrieve a single project by ID. - PATCH
/projects/:id— Update project metadata. - DELETE
/projects/:id— Permanently delete a project.
Error Codes
| Code | Status | Meaning |
|---|---|---|
| 400 | Bad Request | Invalid request body or missing required fields. |
| 401 | Unauthorized | Missing or invalid API key. |
| 403 | Forbidden | Authenticated user lacks permission. |
| 404 | Not Found | Resource does not exist. |
| 429 | Too Many Requests | Rate limit exceeded. Retry after the indicated delay. |
| 500 | Server Error | Unexpected error on our side. |