---
title: "Retrieves the collection of Deal resources."
method: GET
path: "/deals"
tags: ["Deal"]
---

# Retrieves the collection of Deal resources.

`GET /deals`

## Request

- Base URL: `https://example.myintranetapps.com/api`
- URL: `https://example.myintranetapps.com/api/deals`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/bossinsights/apis/boss-insights/docs/deals/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the collection of Deal resources.

## Query parameters

- `page` integer
- `itemsPerPage` integer

## Response `200`

Deal collection

- Deal[]
  - `id` string
  - `integration` string: The key of the integration source e.g. "quickbooks", or "xero"
  - `srcId` string
  - `ownerId` string, nullable: User Id of deal responible
  - `ownerName` string, nullable: User name of deal responsible
  - `stage` string, nullable: Deal's stage e.g: decision
  - `dealName` string, nullable: name of the deal
  - `description` string, nullable: Details about the deal
  - `prospectId` string, nullable: Id of the prospect customer the deal is related to
  - `prospectName` string, nullable: name of the customer the deal is related to
  - `expectedRevenue` integer, nullable: expected revenue from the deal
  - `currency` string, nullable: currency code of the deal e.g: USD
  - `created` string, nullable: date and time the deal is first created
  - `closed` string, date-time, nullable: date and time the deal is closed
  - `associatedContactIds` string[], nullable: A list of contact IDs that are associated with the deal
  - `associatedCompanyIds` string[], nullable: A list of company IDs that are associated with the deal
  - `numAssociatedContacts` integer, nullable: The number of associated contacts

---

[API](https://skmtc.dev/bossinsights/apis/boss-insights.md) - [All operations](https://skmtc.dev/bossinsights/apis/boss-insights/llms.txt) - [OpenAPI document](https://skmtc.dev/bossinsights/apis/boss-insights/revisions/d08a107895ad?raw)