Cerclen API

Overview

What the Cerclen API does, and how to reach it.

The Cerclen API gives your own tools, and AI agents, the same access to a deal that you have in Cerclen: its request list, the conversation on each request, the files given in answer, and the people on the deal. A key can read, raise, edit, assign, move and answer requests for you, as far as you could in the app; deleting stays in the app.

The essentials

  • Base URL: https://app.cerclen.com/api/v1
  • Authentication: Authorization: Bearer <key>, with a key you make on your organization's API Keys page. A key acts as you: it sees and does only what you can. See Keys and authentication.
  • Format: JSON in and out, UTF-8, timestamps in ISO 8601 (UTC), ids as strings.
  • For AI assistants: an MCP server at https://app.cerclen.com/api/mcp, with the same keys.
  • Machine-readable: the OpenAPI document describes every endpoint; this site's llms.txt is a map of these docs for AI agents.

What you can do

AreaEndpoints
AccountWho the key acts as, its organization, the key itself
DealsThe deals you are on, one deal with your place on it, its people
RequestsThe whole list; one request; create; edit, assign and move the status
ConversationsA request's answers, questions and notes; post one, with links
FilesA short-lived download link for a file given in answer

Stability

/v1 only grows: new endpoints, new fields, new values in a list of choices. Nothing is renamed or removed while it is /v1; a breaking change would be /v2, announced well ahead. Write your client to ignore fields it doesn't know.

On this page