Skip to main content

​
Overview

Adminest exposes a REST API for managing your documents, tasks, categories, and AI conversations programmatically. The API is the same one the Adminest web app uses, so anything you can do in the UI you can also automate.

Authentication

Auth0 OAuth 2.0 access tokens

REST + JSON

Predictable URLs, JSON request/response

Production base URL

https://adminest-backend.delightfulpebble-f95388de.eastus.azurecontainerapps.io

Categories endpoint

The new V2 endpoints — including PUT /api/categories/:id

​
Authentication

Every endpoint requires a valid Auth0 access token. Pass it in the Authorization header: 
Authorization: Bearer <ACCESS_TOKEN>
Tokens are issued by Auth0’s custom domain https://auth0.adminest.com/ and have an audience of https://adminest-api. See your Auth0 dashboard for details on requesting tokens for your own clients.

​
Rate limits

BucketLimit
General API5,000 requests per 15 minutes per user
Security API1,000 requests per 15 minutes per user
Rate limit responses include CORS headers so browser clients can detect them. When you hit a limit you’ll receive a 429 Too Many Requests with a Retry-After header.

​
Error format

Errors return a consistent JSON shape: 
{
  "error": "Human-readable message",
  "code": "MACHINE_READABLE_CODE"
}
Stack traces and internal details are never returned to clients.

​
Available endpoints

Categories

Manage the colour and emoji of your document/task categories. Includes the new V2 PUT endpoint.
More endpoints (documents, tasks, chat) will be documented here ahead of full public API availability. In the meantime, see Developers > Architecture for an overview of the system.