API Reference

Complete API endpoint documentation for the Equa platform

API Reference

The Equa platform exposes a RESTful API through equa-server. This section documents every endpoint group with request/response schemas, authentication requirements, and examples.

Base URL

Environment	URL
Production	https://api.equa.cc

Authentication

All API endpoints require an authenticated session. The server uses express-session with a database-backed store (TypeORM). After signing in via Google OAuth, the server sets an HTTP session cookie that the browser includes automatically with each request.

Cookie: connect.sid=<session-id>

There are no JWT bearer tokens. Sessions use rolling: true, which extends the expiry on every request.

Overview Documents

Document	Description	Status
Authentication	API authentication, session cookies, Google OAuth	DRAFT
Error Codes	Standard error responses and status codes	DRAFT
Rate Limiting	Request rate limits and throttling	DRAFT
Webhooks	Webhook events and delivery	DRAFT
SDK Guide	Client SDK usage and integration	DRAFT

Endpoint Groups (18)

All endpoint definitions are located in equa-server/modules/api/src/endpoints/.

Endpoint Group	Source File	Description	Status
Auth	auth-endpoints.ts	Authentication and session management	DRAFT
User	user-endpoints.ts	User profile and preferences	DRAFT
Organization	organization-endpoints.ts	Organization CRUD and settings	DRAFT
Cap Table	captable-endpoints.ts	Equity, shares, stakeholders	DRAFT
Billing	billing-endpoints.ts	Subscription and payment management	DRAFT
Admin	admin-endpoints.ts	Platform administration	DRAFT
Activity	activity-endpoints.ts	Activity feed and audit trail	DRAFT
Data Room	data-room-endpoints.ts	Secure document sharing	DRAFT
Documents	document-endpoints.ts	Document management and DocGen	DRAFT
Microsoft	microsoft-endpoints.ts	Microsoft integration	DRAFT
Google Drive	google-drive-endpoints.ts	Google Drive sync (commented out in registration)	DRAFT
Referral	referral-endpoints.ts	Referral program	DRAFT
Colors	color-endpoints.ts	UI color/theme endpoints	DRAFT
Wallet	wallet-endpoint.ts	Wallet/payment methods	DRAFT
Profile	profile-endpoints.ts	User profile endpoints	DRAFT
File Storage	file-storage-endpoints.ts	File upload/download pipeline	DRAFT
Notifications	notification-endpoints.ts	Notification delivery endpoints	DRAFT
Agent	agent-endpoints.ts	Equanaut AI agent endpoints	DRAFT

How to Document an Endpoint

1. Copy templates/api-endpoint.md into api/endpoints/.
2. Read the source endpoint file and its associated service module.
3. Document every route, request schema, response schema, and error case.
4. Update this index and README.md when the status changes.