Getting started

1. Make a keyCopy Anchor Link

In Cerclen, open your organization and choose Integrations → API Keys. Under New key:

• Name it after what will use it, such as Data room sync.
• Access: Read only for anything that only reads; Read and write to answer, create or change requests.
• Deals: leave all unchecked for every deal you are on, or check the ones it may reach.
• Expires after 30, 90 or 365 days.

Choose Create key and copy the key. It starts with ck_ and is shown this once: Cerclen keeps only a fingerprint of it.

2. Load it in your terminalCopy Anchor Link

So the key doesn't land in your shell history, paste it into a prompt that doesn't echo:

read -s "CERCLEN_KEY?Paste your Cerclen key: "; export CERCLEN_KEY

read -rsp "Paste your Cerclen key: " CERCLEN_KEY; export CERCLEN_KEY

3. Ask who you areCopy Anchor Link

curl https://app.cerclen.com/api/v1/me \
  -H "Authorization: Bearer $CERCLEN_KEY"

{
  "user": { "id": "01a1…", "name": "Olivia Owner", "email": "olivia@northgate.example" },
  "organization": { "id": "01a1…", "name": "Northgate Capital" },
  "key": {
    "id": "01a1…",
    "name": "Data room sync",
    "prefix": "ck_QvMpCqFT",
    "access": "read",
    "deal_ids": null,
    "expires_at": "2027-01-09T02:48:22Z"
  }
}

4. Find a deal and read its listCopy Anchor Link

curl https://app.cerclen.com/api/v1/deals \
  -H "Authorization: Bearer $CERCLEN_KEY"

Take a deal's id and fetch its request list: every section and request, in the list's order.

curl https://app.cerclen.com/api/v1/deals/$DEAL_ID/requests \
  -H "Authorization: Bearer $CERCLEN_KEY"

Each request carries its status, its assignee, its newest answer, the files given in answer, and can: what you may do to it.

5. Read a conversationCopy Anchor Link

curl https://app.cerclen.com/api/v1/deals/$DEAL_ID/requests/$REQUEST_ID/messages \
  -H "Authorization: Bearer $CERCLEN_KEY"

From here, answer requests with an agent, or browse the reference for every endpoint.