---
title: "List sales opportunities"
method: GET
path: "/sales-opportunities"
tags: ["Sales Opportunities"]
---

# List sales opportunities

`GET /sales-opportunities`

## Request

- Base URL: `https://connect.clever.gy`
- URL: `https://connect.clever.gy/sales-opportunities`
- Auth: API key in header `clevergy-api-key`

Returns a paginated list of sales opportunities for the tenant.
Currently only CONTRACT opportunities are returned.
Results are sorted by createdAt descending.

## Query parameters

- `page` integer
- `size` integer
- `status` 'STARTED' | 'POTENTIAL' | 'FORMALIZED' | 'CONVERTED' | 'REJECTED'
- `product` 'CONTRACT'

## Response `200`

Paginated list of sales opportunities

- SalesOpportunitiesPage: Paginated list of sales opportunities
  - `size` integer, required: Number of elements in the page requested
  - `page` integer, required: Number of the page requested
  - `totalPages` integer, required: Number of total pages
  - `totalElements` integer, required: Number of total elements in the list
  - `elements` SalesOpportunitySummary[], required: List of sales opportunities
    - `id` string, required
    - `product` 'CONTRACT' | 'SOLAR' | 'HEATPUMP' | 'BATTERY' | 'DEVICES' | 'EV' | 'OTHER', required
    - `status` 'STARTED' | 'POTENTIAL' | 'FORMALIZED' | 'CONVERTED' | 'REJECTED', required
    - `userId` string
    - `holder` string
    - `email` string
    - `phoneNumber` string
    - `nif` string
    - `houseId` string
    - `address` string
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `default`: Unexpected error

---

[API](https://skmtc.dev/clevergy/apis/clevergy-connect-api.md) - [All operations](https://skmtc.dev/clevergy/apis/clevergy-connect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clevergy/apis/clevergy-connect-api/revisions/d333c5eecb5b?raw)