API reference
Every endpoint of /api/v1, with its request and response.
All endpoints live under https://app.cerclen.com/api/v1 and take
Authorization: Bearer <key>. Each page shows the endpoint's parameters, body and responses,
with examples in curl, Python and JavaScript to copy.
| Endpoint | |
|---|---|
GET /me | Who the key acts as |
GET /deals | List deals |
GET /deals/{deal_id} | Get a deal |
GET /deals/{deal_id}/people | List a deal's people |
GET /deals/{deal_id}/requests | List requests |
POST /deals/{deal_id}/requests | Create a request |
GET /deals/{deal_id}/requests/{request_id} | Get a request |
PATCH /deals/{deal_id}/requests/{request_id} | Update a request |
GET /deals/{deal_id}/requests/{request_id}/messages | List a request's messages |
POST /deals/{deal_id}/requests/{request_id}/messages | Post a message |
POST /deals/{deal_id}/files/{version_id}/download-link | Get a download link |
The whole API is also described by its OpenAPI document, for generating a client or handing to an agent.