Does CluGTM publish an OpenAPI specification?

Yes. API v2 is published as an OpenAPI 3 document at https://api.cleanlist.ai/openapi-public-v2.json, and the legacy v1 spec at /openapi-public.json. Both are public; no API key is needed to download them.

Where can I browse the CluGTM API interactively?

Open https://api.cleanlist.ai/docs. The Swagger UI opens on 'v2 (latest)' and has a dropdown to switch to v1. https://api.cleanlist.ai/redoc renders the v2 spec as a read-only reference.

What does the v2 OpenAPI spec cover?

46 operations: workspace (including POST /credits/estimate), lead lists, People Finder, enrichment, smart agents, export, webhooks, actions and GTM agents. Company search and CRM or sequencer sync are live but not in the spec; they are documented on docs.cleanlist.ai.

Can I generate a client SDK from the CluGTM OpenAPI spec?

Yes, with any OpenAPI generator. The generated client includes POST /credits/estimate, so it can run the quote flow for bulk enrichment and smart agents, and the webhooks, actions and GTM agents routes. The served spec leaves out company search and sync, and so do the official SDKs, so add those calls by hand.

🔌

Audience: developers. API keys need a Pro or Enterprise plan (legacy Pro and Scale plans included) or an AppSumo Tier 5, 6 or 7 license, and they never work during a trial. Support agent: confirm the user’s plan grants API access before giving API advice.

TL;DR: The v2 spec is raw JSON at /openapi-public-v2.json. The Swagger UI at /docs opens on v2 (latest) with a dropdown for v1, and Redoc at /redoc renders v2. A few live endpoints (company search and sync) aren’t in the spec.

OpenAPI Specification

CluGTM’s API publishes an OpenAPI 3 document for each version. The v2 spec is filtered to the supported public surface.

URL	Format	Surface	Best for
`https://api.cleanlist.ai/openapi-public-v2.json`	Raw JSON	v2 (current)	Code generation and tooling
`https://api.cleanlist.ai/openapi-public.json`	Raw JSON	v1 (legacy, 5 operations)	The frozen legacy surface
`https://api.cleanlist.ai/docs`	Swagger UI	v2 by default, v1 in the dropdown	Trying requests interactively
`https://api.cleanlist.ai/redoc`	Redoc	v2	A clean read-only reference

What the v2 spec includes

The served v2 spec lists 46 operations under nine tags: Workspace, Lead Lists, People Finder, Enrichment, Smart Agents, Export, Webhooks, Actions and GTM Agents. Workspace includes POST /credits/estimate, so a generated client can mint quotes. Webhooks, Actions and GTM Agents cover webhook subscriptions, actions and approval cards and GTM agents; the official SDKs don’t include them yet.

These live v2 endpoints are not in the spec, but you can call them and they are documented here:

Endpoint	Docs
`GET /search/companies/filters`, `POST /search/companies`, `POST /search/companies/similar`	Company Search API
`POST /migrate/crm`, `POST /migrate/sequencer`, `GET /migrate/status/{workflow_id}`	CRM & Sequencer Sync

Routes built only for the CluGTM MCP are also left out of the spec and this reference.

The v1 spec covers only the five legacy single-file endpoints. The v2 endpoints also answer under /api/v1/public, but they are documented in the v2 spec. See API Versions & Migration.

Browsing interactively

Swagger UI: `/docs`

Swagger UI opens on v2 (latest). Use the spec dropdown at the top to switch to v1. Expand an endpoint to see its request and response schemas, and use “Try it out” to call the live API: paste your clapi_ key into the Authorize dialog (HTTP Bearer) first. Calls made here are real and can spend credits.

Redoc: `/redoc`

Redoc renders the v2 spec as a static three-column reference that’s easier to skim than Swagger when you’re reading rather than experimenting.

Downloading the spec


curl https://api.cleanlist.ai/openapi-public-v2.json -o cleanlist-openapi.json

The spec is public; you can download it without an API key.

Generating a client

A client generated from the served spec includes POST /credits/estimate, so it can run the quote flow for bulk enrichment and smart agents. It has no company search or sync methods, so it can’t sync a list on its own. Add those calls over plain HTTP; the official SDKs don’t include them either.

TypeScript


npx openapi-typescript https://api.cleanlist.ai/openapi-public-v2.json -o ./cleanlist-types.ts

Python


pipx install openapi-python-client
openapi-python-client generate --url https://api.cleanlist.ai/openapi-public-v2.json

Other languages


# Java, Go, Ruby, Rust, C#, PHP, Swift, Kotlin, etc.
npm install -g @openapitools/openapi-generator-cli
openapi-generator-cli generate \
  -i https://api.cleanlist.ai/openapi-public-v2.json \
  -g <language> \
  -o ./cleanlist-client

See the OpenAPI Generator project for the full language list.

Versioning

The API is versioned by URL prefix. /api/v2 is the current surface and what the v2 spec describes; the Legacy API (v1) at /api/v1/public is still supported but frozen. For the full version story and migration steps, see API Versions & Migration.