v1

latestOpenAPI 3.1.02026-07-221206394.4 KB
Deals

List deals

Returns deals in your organization, newest first.

get/v1/deals

Query parameters

pageinteger

Page number, starting at 1 (max 100).

limitinteger

Items per page (1 to 1000).

ltstring

Cursor: return items whose id is less than this value (use the last id from the previous page).

sortstring

Field to sort by. Defaults to id.

direction'asc' | 'desc'

Sort direction.

Response

A list of deals.

Example response

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