Skip to content

OpenAPI reference

The full API is described by an OpenAPI 3.1 document generated from the same Zod schemas used for runtime validation:

GET https://api.commissionsight.com/v1/openapi.json

Load it into any OpenAPI tool (Swagger UI, Redoc, Stoplight) or generate a client. The discovery root is also self-describing:

Terminal window
curl https://api.commissionsight.com/v1

returns top-level HATEOAS _links to carriers, files, jobs, members, comparisons, reports, and webhooks.

TypeScript SDK

import { CommissionSightClient } from '@commissionsight/sdk';
const client = new CommissionSightClient({
baseUrl: 'https://api.commissionsight.com/v1',
token: process.env.CS_TOKEN,
});
const { data } = await client.listJobs({ status: 'completed' });