Cerclen API
Deals

Get a deal

GET
/api/v1/deals/{deal_id}

Authorization

ApiKey
headerAuthorizationBearer <token>

An API key from your organization's API Keys page in Cerclen.

Path Parameters

deal_id*Deal Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
archived*Archived

Archived deals are read-only, and listed only for their project admins.

codename*Codename
id*Id
me*

Your place on the deal.

name*Name

The project name, such as Project Kestrel.

parties*array<>
timezone*Timezone

The IANA time zone its due dates fall due in.

curl -X GET 'https://app.cerclen.com/api/v1/deals/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H "Authorization: Bearer $CERCLEN_KEY"
{  "archived": true,  "codename": "string",  "id": "string",  "me": {    "access": "admin",    "is_project_admin": true,    "participant_id": "string",    "party_id": "string"  },  "name": "string",  "parties": [    {      "id": "string",      "is_owner": true,      "label": "string",      "side": "buy"    }  ],  "timezone": "string"}

Post a message POST

An answer, a question, a reference or an internal note, in Markdown, with links. Marked "via API" for everyone who sees it. 403 `cannot_post`; 400 `empty_message`.

List deals GET

The deals the key reaches: its owner's, or the ones the key is limited to. An archived deal is listed only for its project admins.