# Resources

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.

Version: 1.0.0

## Servers

API server
```
https://api.listalpha.com
```

## Security

### ApiKeyAuth

Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

[Resources](https://docs.listalpha.com/_bundle/openapi.yaml)

## 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**.

### List Pipelines

 - [GET /v1/deals/pipelines](https://docs.listalpha.com/openapi/deals/publicdealmetadatacontroller.getpipelineswithstages.md): 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.

### List Custom Fields

 - [GET /v1/deals/custom-fields](https://docs.listalpha.com/openapi/deals/publicdealmetadatacontroller.getcustomfields.md): Custom fields allow users to store additional information alongside a deal. EBITDA, revenue multiple, and other financial metrics can be tracked using custom fields.

### List Deals

 - [GET /v1/deals](https://docs.listalpha.com/openapi/deals/publicdealcontroller.getdeals.md): Return deals based on search criteria, with filtering, sorting, and pagination.

### Create Deal

 - [POST /v1/deals](https://docs.listalpha.com/openapi/deals/publicdealcontroller.createdeal.md)

### Patch Deal

 - [PATCH /v1/deals/{id}](https://docs.listalpha.com/openapi/deals/publicdealcontroller.updatedeal.md)

### Delete Deal

 - [DELETE /v1/deals/{id}](https://docs.listalpha.com/openapi/deals/publicdealcontroller.deletedeal.md)