Skip to main content

​
Overview

The Adminest API allows you to programmatically interact with documents, tasks, and other features. All API endpoints require authentication using JWT tokens from Auth0.

​
Base URL

Production: https://api.adminest.com

​
Authentication

All API requests require a valid JWT bearer token in the Authorization header: 
Authorization: Bearer YOUR_JWT_TOKEN
Tokens are obtained through Auth0 authentication. See Authentication for details.

​
Request Format

  • All request bodies should be JSON (Content-Type: application/json)
  • File uploads use multipart/form-data

​
Response Format

All responses are JSON with the following structure: Success Response: 
{
  "data": { ... },
  "message": "Success"
}
Error Response: 
{
  "error": "Error message",
  "code": "ERROR_CODE",
  "details": { ... }
}

​
HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing token
403Forbidden - Insufficient permissions
404Not Found
500Server Error

​
Rate Limiting

API requests are rate limited to:
  • 100 requests per minute per user
  • 1000 requests per hour per user

​
Security

All API inputs are validated and sanitized server-side. Search parameters are escaped to prevent injection attacks, and error responses never expose internal system details. Admin endpoints enforce strict format validation on all path parameters. Admin authorization uses exact email matching to prevent spoofing via substring attacks.

​
Data Protection

Adminest runs automated daily backups of all data. Backups are stored securely in Azure Blob Storage with 30-day retention and 14-day soft delete protection on document files. The platform health endpoint monitors backup freshness and alerts if backups are stale. Rate limit headers are included in responses: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1234567890

​
Quick Start

  1. Get an API token via Auth0 authentication
  2. Make a test request:
curl -X GET https://api.adminest.com/api/documents \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

​
API Reference

Authentication

How to authenticate API requests

Documents

Upload, list, and manage documents

Tasks

Create and manage tasks

Chat

AI assistant interactions