Commenting

Bring comments from an external system into Anduin, and read Anduin conversations back out.

The Comment API lets you bring selected comments from a CRM, fund accounting platform, or another external system into Anduin, and read Anduin conversations back into your system. This keeps fund teams, investors, and collaborators in the right context while supporting reporting, archival, reconciliation, and external workflows.

Guides

Before you begin

Notice: The Comment API must be enabled for your fund. Contact your Anduin customer success representative to get started.

A Fund Subscription contains orders. Each order represents one investor's subscription, and its comments live in threads attached to that order.

You need an API key, a fund ID, and an order ID for each subscription. See Authentication for API-key setup and security guidance. If you do not have the order IDs yet, call Get fund information with your fund ID and read the orderIds array from the response, which lists every order in the fund.

Set up a typed TypeScript client with openapi-ts

The examples in these guides use openapi-ts. It generates TypeScript types from the API's OpenAPI specification at build time, so no generated SDK code is shipped with your integration. Requests use openapi-fetch, a small typed wrapper around the platform's native fetch; paths, parameters, request bodies, and responses are checked against the specification.

Prototyping? The API is plain HTTPS and JSON, so you can also use curl, Postman, or the auto-generated api SDK offered on the API reference page. The examples in these guides standardize on openapi-ts.

Keep the API key in an environment variable rather than in source code. On Node 23.6 or later, run the TypeScript examples directly with node script.ts; on older runtimes, use tsx. openapi-fetch does not throw on HTTP errors: each call returns { data, error }, and the examples check error explicitly.

Set up the project once:

  1. Run npm init -y, then npm pkg set type=module.
  2. Install the client and generator: npm i openapi-fetch and npm i -D openapi-typescript typescript @types/node.
  3. Generate types from the specification: npx openapi-typescript https://api.anduin.app/api/v1/fundsub/docs/docs.yaml -o anduin-fundsub.ts. This produces types only; regenerate them whenever the API is updated.
  4. Create the shared client. All TypeScript examples in the workflow guides import this client with import { client } from "./client.ts" and do not repeat the setup:
// client.ts
import createClient from "openapi-fetch";
import type { paths } from "./anduin-fundsub.ts";

const apiKey = process.env.ANDUIN_API_KEY;
if (!apiKey) throw new Error("Set ANDUIN_API_KEY before running.");

export const client = createClient<paths>({
  baseUrl: "https://api.anduin.app",
  headers: { authorization: apiKey },
});

Did this page help you?