# List Deals

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

Endpoint: GET /v1/deals
Version: 1.0.0
Security: ApiKeyAuth

## Query parameters:

  - `search` (string)

  - `stages` (array)

  - `pipelines` (array)

  - `limit` (integer, required)

  - `offset` (integer, required)

## Response 200 fields (application/json):

  - `deals` (array, required)

  - `deals.id` (string, required)

  - `deals.company` (object)

  - `deals.company.name` (string)

  - `deals.company.url` (string)

  - `deals.comment` (string)

  - `deals.tags` (array)

  - `deals.creatorId` (string)

  - `deals.pipelineId` (string)

  - `deals.stageId` (string)

  - `deals.addedAt` (any)

  - `deals.createdAt` (any)

  - `deals.updatedAt` (any)

  - `deals.fields` (object)