DocGate API Documentation
Build integrations with the DocGate document sharing and analytics platform.
Authentication
All API requests require a Bearer token. Generate an API key in your workspace under Settings > Developer.
API keys use the dg_live_ prefix. Keep your key secret and never expose it in client-side code.
Base URL
All endpoints are scoped under /api/v1. Requests are workspace-scoped based on the API key used.
Rate Limits
Rate limits are applied per API key using a sliding window:
- Free: 100 requests per minute
- Pro: 1,000 requests per minute
- Business: 5,000 requests per minute
Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in every response.
Pagination
List endpoints use cursor-based pagination with two parameters:
limit— Number of items (1–100, default 20)starting_after— Cursor ID from the previous page
Responses include has_more and next_cursor fields to drive pagination.
Error Format
Errors follow a consistent envelope inspired by the Stripe API:
{
"error": {
"type": "invalid_request_error",
"message": "Document not found",
"code": "resource_not_found"
}
}Error types: authentication_error, invalid_request_error, rate_limit_error, api_error.
Try It Out
Use the interactive explorer below to browse endpoints, view schemas, and send test requests directly from this page.
OpenAPI Specification
The full machine-readable spec is available at /api/openapi (requires authentication). Import it into tools like Postman, Insomnia, or any OpenAPI-compatible client.
Endpoints
/api/v1/health/api/v1/documents/api/v1/documents/api/v1/documents/:id/api/v1/documents/:id/api/v1/documents/:id/api/v1/documents/:id/links/api/v1/documents/:id/links/api/v1/links/:id/api/v1/links/:id/api/v1/links/:id/api/v1/folders/api/v1/folders/api/v1/folders/:id/api/v1/folders/:id/api/v1/documents/:id/analytics/api/v1/documents/:id/analytics/pages/api/v1/links/:id/views/api/v1/views/api/v1/data-rooms/api/v1/data-rooms/api/v1/data-rooms/:id/api/v1/data-rooms/:id/api/v1/data-rooms/:id/api/v1/data-rooms/:id/documents/api/v1/data-rooms/:id/documents/api/v1/data-rooms/:id/documents/:documentId/api/v1/data-rooms/:id/analytics