API Documentation

Full reference for the TotalApp REST API — authentication, endpoints, rate limits and code examples.

Beta

The TotalApp API is currently in beta. Endpoints, payloads and rate limits may still change before general availability — avoid depending on it for critical production integrations just yet, and expect this reference to evolve alongside it.

Getting Started

The API lets you integrate TotalApp directly into your own software systems: pull and push records from any tenant module, trigger the AI engine from your own tools, or build custom automations on top of your workspace data without leaving your existing stack.

The TotalApp API is a RESTful HTTP API. All requests are authenticated via Bearer tokens and return JSON responses. Base URL for all endpoints:

Base URL

https://app.totalapp.app/api

Authentication

Obtain your API token from Settings → API & Integrations → API Keys. Include it in every request:

Authorization Header

Authorization: Bearer YOUR_API_TOKEN

Core Endpoints

Method	Path	Description
GET	/api/data/employees	List all employees in your tenant
POST	/api/data/employees	Create or update employee records
GET	/api/data/projects-index	List all project boards
GET	/api/data/financial-accounts	List financial accounts
POST	/api/claude	Run a prompt through the AI engine
GET	/api/auth/me	Return the current authenticated user

Rate Limits

API rate limits are enforced per tenant and plan:

Plan	Requests / minute	Requests / day
Starter	30	1,000
Basic / Standard	120	10,000
Pro	500	100,000
Enterprise	Unlimited	Unlimited

When a rate limit is exceeded the API returns 429 Too Many Requests. Retry after the number of seconds specified in the Retry-After header.

Error Responses

All errors return a JSON object with a human-readable error field:

Error Format

{ "error": "Tenant not found or access denied" }

Status	Meaning
400	Bad request — invalid body or missing required field
401	Unauthorized — missing or invalid Bearer token
403	Forbidden — token valid but insufficient role
404	Resource not found
429	Rate limit exceeded
500	Internal server error

Frequently Asked Questions

Where do I find my API token?

Go to Settings → API & Integrations → API Keys and click Generate New Key. Copy the token immediately — it will not be shown again.

Are API calls tenant-scoped?

Yes. Every API request is automatically scoped to the tenant of the authenticated user. You cannot read or write data belonging to another tenant.

Can I use the API in a Zapier or Make scenario?

Yes — use the HTTP / Webhook module in Zapier or Make and pass your Bearer token in the Authorization header. Native Zapier and Make apps are planned for a future release.

What happens if I exceed my plan's rate limit?

Requests over the limit receive a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait before retrying. Rate limits scale with your plan tier — see the SDKs and Libraries page for the full table.