Skip to main content
Source: Cross-reference guide — endpoint paths verified against equa-server/modules/api/src/endpoints/

SDK Guide

The Equa API is a standard REST API that can be consumed from any HTTP client. This guide covers common patterns using the browser fetch API.

Setup

Browser clients should use the same-origin API path exposed by the current SPA host:
If you need an absolute URL outside the browser, use https://app.equa.cc/api/v1 unless a direct API hostname has been freshly re-verified. Every request must include credentials: 'include' so the session cookie is sent automatically.

Helper Function

A reusable API helper simplifies repeated patterns:

Authentication

Login

Google OAuth Login

Magic link endpoints (/user/magic-link and /user/magic-link/verify) are implemented in the auth module but not yet registered as REST endpoints. This example shows the planned usage.

Get Current User

Logout

Organizations

List Organizations

Get Organization Details

Create Organization

Cap Table

List Shareholdings

Create a Shareholding

Get Securities

Members

List Organization Members

Invite Members

Documents (Data Room)

List Documents

Upload a Document

Download a Document

Billing

Get Products

Get Organization Subscriptions

Agent (Equanaut)

Chat with the Agent

Error Handling

See Error Codes for the complete list of status codes. A common pattern: