Skip to content

Resources (1.0.0)

The core entities of ListAlpha CRM are Deals, Companies, Contacts, and Investors. Deals track potential and active investments. Companies represent legal entities, while Contacts capture people such as executives, advisers, and bankers.

The API give access to programmatically change deals entity.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
API server
https://api.listalpha.com

Deals

A deal represents the process of acquiring a company. Every deal on the platform belongs to a pipeline and is associated with a specific stage within that pipeline. The Deal entity supports configurable custom fields.

Operations

List Pipelines

Request

A pipeline represents the sequence of stages a deal passes through from initiation to completion. The Deal and Credit teams use different pipelines to manage their workflows effectively.

Security
ApiKeyAuth
curl -i -X GET \
  https://api.listalpha.com/v1/deals/pipelines \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
pipelinesArray of objects(ViewPipelineDto)required
pipelines[].​idstringrequired
pipelines[].​namestringrequired
pipelines[].​stagesArray of objects(ViewPipelineStageDto)required
pipelines[].​stages[].​idstringrequired
pipelines[].​stages[].​namestringrequired
Response
application/json
{
  "pipelines": [
    { … }
  ]
}

List Custom Fields

Request

Custom fields allow users to store additional information alongside a deal. EBITDA, revenue multiple, and other financial metrics can be tracked using custom fields.

Security
ApiKeyAuth
curl -i -X GET \
  https://api.listalpha.com/v1/deals/custom-fields \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
fieldsArray of objects(CustomFieldDto)required
fields[].​fieldIdstringrequired
fields[].​labelstringrequired
Response
application/json
{
  "fields": [
    { … }
  ]
}

List Deals

Request

Return deals based on search criteria, with filtering, sorting, and pagination.

Security
ApiKeyAuth
Query
searchstring
stagesArray of strings
pipelinesArray of strings
limitinteger[ 1 .. 100 ]required
offsetinteger[ 0 .. 1000000 ]required
curl -i -X GET \
  'https://api.listalpha.com/v1/deals?search=string&stages=string&pipelines=string&limit=1&offset=1000000' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dealsArray of objects(DealDto)required
deals[].​idstring^[0-9a-fA-F]{24}$required
deals[].​companyobject(DealCompanyDto)
deals[].​commentstring
deals[].​tagsArray of strings
deals[].​creatorIdstring
deals[].​pipelineIdstring
deals[].​stageIdstring
deals[].​addedAtstring
One of:
string(date)
deals[].​createdAtstring
One of:
string(date)
deals[].​updatedAtstring
One of:
string(date)
deals[].​fieldsobject
Response
application/json
{
  "deals": [
    { … }
  ]
}

Create Deal

Request

Security
ApiKeyAuth
Bodyapplication/json

DealCreateDto

companyobject(DealCompanyDto)
commentstring
tagsArray of strings
pipelineIdstringrequired
stageIdstringrequired
addedAtstring
One of:
string(date)
fieldsobject
curl -i -X POST \
  https://api.listalpha.com/v1/deals \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "company": {
      "name": "string",
      "url": "string"
    },
    "comment": "string",
    "tags": [
      "string"
    ],
    "pipelineId": "string",
    "stageId": "string",
    "addedAt": "2019-08-24",
    "fields": {}
  }'

Responses

Bodyapplication/json
idstring^[0-9a-fA-F]{24}$required
companyobject(DealCompanyDto)
commentstring
tagsArray of strings
creatorIdstring
pipelineIdstring
stageIdstring
addedAtstring
One of:
string(date)
createdAtstring
One of:
string(date)
updatedAtstring
One of:
string(date)
fieldsobject
Response
application/json
{
  "id": "string",
  "company": {
    "name": "string",
    "url": "string"
  },
  "comment": "string",
  "tags": [
    "string"
  ],
  "creatorId": "string",
  "pipelineId": "string",
  "stageId": "string",
  "addedAt": "2019-08-24",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "fields": {}
}

Patch Deal

Request

Security
ApiKeyAuth
Path
idstring[^\/#\?]+?required
Bodyapplication/json

DealPatchDto

companyobject(DealCompanyDto)
commentstring
tagsArray of strings
stageIdstring
fieldsobject
curl -i -X PATCH \
  'https://api.listalpha.com/v1/deals/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "company": {
      "name": "string",
      "url": "string"
    },
    "comment": "string",
    "tags": [
      "string"
    ],
    "stageId": "string",
    "fields": {}
  }'

Responses

Bodyapplication/json
idstring^[0-9a-fA-F]{24}$required
companyobject(DealCompanyDto)
commentstring
tagsArray of strings
creatorIdstring
pipelineIdstring
stageIdstring
addedAtstring
One of:
string(date)
createdAtstring
One of:
string(date)
updatedAtstring
One of:
string(date)
fieldsobject
Response
application/json
{
  "id": "string",
  "company": {
    "name": "string",
    "url": "string"
  },
  "comment": "string",
  "tags": [
    "string"
  ],
  "creatorId": "string",
  "pipelineId": "string",
  "stageId": "string",
  "addedAt": "2019-08-24",
  "createdAt": "2019-08-24",
  "updatedAt": "2019-08-24",
  "fields": {}
}

Delete Deal

Request

Security
ApiKeyAuth
Path
idstring[^\/#\?]+?required
curl -i -X DELETE \
  'https://api.listalpha.com/v1/deals/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
successbooleanrequired
Response
application/json
{
  "success": true
}