---
title: "Get deals by ids"
method: GET
path: "/v1/deals/ids={ids}"
tags: ["Deals"]
---

# Get deals by ids

`GET /v1/deals/ids={ids}`

## Request

- Base URL: `https://api.metal.ai`
- URL: `https://api.metal.ai/v1/deals/ids={ids}`
- Auth: API key in header `x-metal-client-id` and API key in header `x-metal-api-key`
- TypeScript: <https://skmtc.dev/metal/apis/metal-api/docs/v1/deals/ids=:ids/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves multiple deals in a single request.

## Path parameters

- `ids` string, required

## Response `200`

The matching deals.

- object
  - `data` Deal[]
    - `id` string
    - `name` string
    - `companyId` string: The target company's id.
    - `status` 'ACTIVE' | 'CLOSED' | 'PASSED_DEAD': Internal lifecycle status.
    - `stage` 'SOURCED' | 'SCREENED' | 'IOI_TERM_SHEET' | 'DUE_DILIGENCE' | 'IC_MEETING' | 'DEAL_CLOSING' | 'PORTFOLIO_COMPANY' | 'REALIZED' | 'PASSED' | 'DEAD': Pipeline stage.
    - `externalStatus` string: Your firm's custom status label, when configured.
    - `externalStage` string: Your firm's custom stage label, when configured.
    - `acquisitionType` 'add_on' | 'platform': Derived, read-only classification of the deal. `add_on` if the deal has a platform company (an add-on acquisition under an existing portfolio company), otherwise `platform`. Computed on read from the deal's platform company; cannot be set via create, update, or any other write endpoint.
    - `owners` Reference[]
      - `id` string
      - `type` string: The referenced resource type, e.g. "user" or "team".
    - `sector` string
    - `industry` string
    - `size` number
    - `notes` string
    - `externalReference` ExternalReference: A structured reference to a record in an external source system.
      - `source` string: The external system, e.g. a CRM provider.
      - `id` string: The record id in the external system.

## Other responses

- `401`: Missing or invalid API key credentials.

---

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