Cerclen API
Requests

Get a request

GET
/api/v1/deals/{deal_id}/requests/{request_id}

Authorization

ApiKey
headerAuthorizationBearer <token>

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

Path Parameters

request_id*Request Id
Formatuuid
deal_id*Deal Id
Formatuuid

Response Body

Successful Response

application/json
  1. response

A request on the deal's list. A section is a heading over requests: it has no status, assignee or answers of its own.

allowed_statuses*array<>

The statuses you may move it to from here.

assignee_id*|

The person id of whoever is to answer it.

body*Body

The request in full, in Markdown.

can*

What you may do to this request.

category*RequestCategory

The DRL's workstreams (ADR-0031). Shown with the firm raising the request — "Legal - Kirkland & Ellis" — or "Financial Sponsor" when none is named.

Value in"business""legal""tax""accounting""technology""human_resources"
created_at*Created At
Formatdate-time
due_date*|

A calendar day in the deal's time zone.

files*array<>

Every file and link given in answer to it.

id*Id
kind*RequestKind

A row of the list (ADR-0017): a request, or a section heading that groups the requests under it — a number and a title, never a status, an assignee or an answer.

Value in"request""section"
latest_answer*|null
number*Number

Its number on the list, such as 3.2.

parent_id*|

The section it sits under; null at the top level.

priority*Priority

A request's urgency. Ordering for display is client-side (never ORDER BY).

Value in"low""medium""high"
requester*|

The advisor firm raising it; null for the Financial Sponsor.

status*RequestStatus
Value in"open""partial""complete"
status_changed_at*|null
title*Title
updated_at*Updated At
Formatdate-time
curl -X GET 'https://app.cerclen.com/api/v1/deals/497f6eca-6276-4993-bfeb-53cbbbba6f08/requests/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H "Authorization: Bearer $CERCLEN_KEY"
{  "allowed_statuses": [    "open"  ],  "assignee_id": "string",  "body": "string",  "can": {    "answer": true,    "assign": true,    "change_status": true,    "edit": true  },  "category": "business",  "created_at": "2019-08-24T14:15:22Z",  "due_date": "2019-08-24",  "files": [    {      "content_type": "string",      "downloadable": true,      "kind": "file",      "name": "string",      "size": 0,      "url": "string",      "version_id": "string"    }  ],  "id": "string",  "kind": "request",  "latest_answer": {    "author": {      "email": "string",      "id": "string",      "name": "string"    },    "message_id": "string",    "partial": true,    "posted_at": "2019-08-24T14:15:22Z",    "preview": "string",    "source": "email"  },  "number": "string",  "parent_id": "string",  "priority": "low",  "requester": "string",  "status": "open",  "status_changed_at": "2019-08-24T14:15:22Z",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z"}