Sign in

v1

latestOpenAPI 3.1.02026-07-221206394.4 KB
Deals

Create a deal

Creates a deal. Provide a name and, typically, the target companyId.

post/v1/deals

Request body

namestring required
companyIdstring

The target company's id.

status'ACTIVE' | 'CLOSED' | 'PASSED_DEAD'
stage'SOURCED' | 'SCREENED' | 'IOI_TERM_SHEET' | 'DUE_DILIGENCE' | 'IC_MEETING' | 'DEAL_CLOSING' | 'PORTFOLIO_COMPANY' | 'REALIZED' | 'PASSED' | 'DEAD'
sectorstring
industrystring
sizenumber
notesstring
externalIdstring

Example request

{
  "name": "Project Atlas"
}

Response

A deal.

Example response

{
  "data": {
    "id": "665f1c2a9b1e4a0012a3b4c5",
    "name": "Project Atlas",
    "status": "ACTIVE",
    "stage": "DUE_DILIGENCE",
    "acquisitionType": "platform"
  }
}