---
title: "List deals"
method: GET
path: "/v1/deals"
tags: ["Deals"]
---

# List deals

`GET /v1/deals`

Retrieve a paginated list of deals

## Query parameters

- `limit` integer
- `offset` integer
- `page` integer
- `origin_id` string, uuid
- `created_at_start` string, date-time
- `created_at_end` string, date-time
- `updated_at_start` string, date-time
- `updated_at_end` string, date-time
- `user_id` string, uuid
- `user_email` string
- `contact_id` string, uuid
- `phone` string
- `email` string
- `tag_ids` string
- `tag_names` string
- `status` 'OPEN' | 'WON' | 'LOST'
- `stage_id` string, uuid
- `updated_stage_at_start` string, date-time
- `updated_stage_at_end` string, date-time
- `fields` object
- `won_at_start` string, date-time
- `won_at_end` string, date-time
- `lost_at_start` string, date-time
- `lost_at_end` string, date-time

## Headers

- `api-token` string, required

## Response `200`

A list of deals

- object
  - `status` integer — Response status
  - `totalCount` integer — Total items based on current filters
  - `page` integer — Current page
  - `totalPages` integer — Total pages based on current filters
  - `hasNext` boolean — Indicates that has next page
  - `hasPrevious` boolean — Indicates that has previous page
  - `data` Deal[]
    - `id` string, uuid
    - `origin_id` string, uuid
    - `user` object
      - `id` string, uuid
      - `full_name` string
    - `contact` object
      - `id` string, uuid
      - `name` string
      - `email` string
      - `phone` string
    - `created_at` string, date-time
    - `stage_id` string, uuid
    - `updated_stage_at` string, date-time
    - `status` 'OPEN' | 'WON' | 'LOST'
    - `won_at` string, date-time
    - `won_by` string, uuid
    - `lost_status_id` string, uuid
    - `lost_at` string, date-time
    - `lost_by` string, uuid
    - `fields` Fields

---

[API](https://skmtc.net/clint/apis/clint-api.md) · [All operations](https://skmtc.net/clint/apis/clint-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clint/clint-api/revisions/12b8f9eff943/schema)